MultiPeak.h

Go to the documentation of this file.

/*
 * This file is part of Vlasiator.
 * Copyright 2010-2016 Finnish Meteorological Institute
 *
 * For details of usage, see the COPYING file and read the "Rules of the Road"
 * at http://www.physics.helsinki.fi/vlasiator/
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef MULTIPEAK_H
#define MULTIPEAK_H
 
#include <vector>
 
#include "../../definitions.h"
#include "../projectTriAxisSearch.h"
 
namespace projects {
   struct MultiPeakSpeciesParameters {
      uint numberOfPeaks;
      std::vector<Real> rho;
      std::vector<Real> Tx;
      std::vector<Real> Ty;
      std::vector<Real> Tz;
      std::vector<Real> Vx;
      std::vector<Real> Vy;
      std::vector<Real> Vz;
      std::vector<Real> rhoPertAbsAmp;
 
      // Test whether parameters have been set up for all peaks
      bool isConsistent() {
         return rho.size() == Tx.size() &&
            Tx.size() == Ty.size() &&
            Ty.size() == Tz.size() &&
            Tz.size() == Vx.size() &&
            Vx.size() == Vy.size() &&
            Vy.size() == Vz.size() &&
            Vz.size() == rhoPertAbsAmp.size() &&
            rhoPertAbsAmp.size() == rho.size() &&
            rho.size() == numberOfPeaks;
      }
   };
   class MultiPeak: public TriAxisSearch {
    public:
      MultiPeak();
      virtual ~MultiPeak();
 
      virtual bool initialize(void) override;
      static void addParameters(void);
      virtual void getParameters(void) override;
      virtual void setProjectBField(
         fsgrids::perbspan perb,
         fsgrids::bgbspan bgb,
         fsgrids::technicalspan technical, FieldSolverGrid& fsgrid
      ) override;
 
      std::vector<MultiPeakSpeciesParameters> speciesParams;
 
      virtual Realf fillPhaseSpace(spatial_cell::SpatialCell* cell,
                                   const uint popID,
                                   const uint nRequested) const override;
      virtual Realf probePhaseSpace(spatial_cell::SpatialCell* cell,
                                    const uint popID,
                                    Real vx_in, Real vy_in, Real vz_in
                                   ) const override;
 
      virtual void calcCellParameters(spatial_cell::SpatialCell* cell, creal& t) override;
      virtual std::vector<std::array<Real, 3>> getV0(creal x, creal y, creal z, const uint popID) const override;
 
      uint seed;
 
      static Real rhoRnd; //static as it has to be threadprivate
      #pragma omp threadprivate(rhoRnd)
      Real Bx;
      Real By;
      Real Bz;
      Real dBx;
      Real dBy;
      Real dBz;
      Real magXPertAbsAmp;
      Real magYPertAbsAmp;
      Real magZPertAbsAmp;
      Real lambda;
 
      enum densitymodel {
         Uniform,
         TestCase
      } densityModel;
 
   }; // class MultiPeak
} //  namespace projects
 
#endif