Dispersion.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 DISPERSION_H
#define DISPERSION_H
 
#include <stdlib.h>
 
#include "../../definitions.h"
#include "../project.h"
 
namespace projects {
 
   struct DispersionSpeciesParameters {
      Real VX0;
      Real VY0;
      Real VZ0;
      Real DENSITY;
      Real TEMPERATURE;
      Real densityPertRelAmp;
      Real velocityPertAbsAmp;
 
   };
 
   class Dispersion: public Project {
    public:
      Dispersion();
      virtual ~Dispersion();
 
      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;
      virtual void hook(
         cuint& stage,
         const dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
         fsgrids::perbspan perb, fsgrids::technicalspan technical, FieldSolverGrid& fsgrid
      ) const override;
      virtual Realf fillPhaseSpace(
         spatial_cell::SpatialCell* cell, const uint popID,
         const uint nRequested
      ) const override;
      virtual void calcCellParameters(spatial_cell::SpatialCell* cell, creal& t) override;
 
      Real B0;
      Real magXPertAbsAmp;
      Real magYPertAbsAmp;
      Real magZPertAbsAmp;
      Real angleXY;
      Real angleXZ;
      Real maxwCutoff;
      std::vector<DispersionSpeciesParameters> speciesParams;
      uint seed;
 
      static Real rndRho, rndVel[3];
      #pragma omp threadprivate(rndRho,rndVel)
   } ; // class Dispersion
} // namespace projects
 
#endif