project.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 PROJECT_H
#define PROJECT_H
 
#include "../spatial_cells/spatial_cell_wrapper.hpp"
#include "fsgrid.hpp"
#include <dccrg.hpp>
#include <dccrg_cartesian_geometry.hpp>
#include <random>
 
namespace projects {

   ARCH_HOSTDEV inline Realf MaxwellianPhaseSpaceDensity(
      creal& vx, creal& vy, creal& vz,
      creal& T, creal& rho, creal& mass
      ) {
      return rho * pow(mass / (2.0 * M_PI * physicalconstants::K_B * T), 1.5) *
         exp(- mass * (vx*vx + vy*vy + vz*vz) / (2.0 * physicalconstants::K_B * T));
   }

   ARCH_HOSTDEV inline Realf TriMaxwellianPhaseSpaceDensity(
      creal& vx, creal& vy, creal& vz,
      creal& Tx, creal& Ty, creal& Tz,
      creal& rho, creal& mass) {
      return rho * pow(mass / (2.0 * M_PI * physicalconstants::K_B), 1.5) *
         exp(- mass * (vx*vx/Tx + vy*vy/Ty + vz*vz/Tz) / (2.0 * physicalconstants::K_B)) /
         sqrt(Tx*Ty*Tz);
   }
 
   class Project {
    public:
      Project();
      virtual ~Project();
      
      static void addParameters();
      
      virtual Real getCorrectNumberDensity(spatial_cell::SpatialCell* cell,const uint popID) const;
      
      virtual void getParameters();
      
      virtual bool initialize();
      
      virtual void hook(cuint& stage, const dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                        fsgrids::perbspan perb,
                        fsgrids::technicalspan technical, FieldSolverGrid &fsgrid) const;
 
      bool initialized();
      
      virtual void setProjectBField(fsgrids::perbspan perb,
                                    fsgrids::bgbspan bgb,
                                    fsgrids::technicalspan technical, FieldSolverGrid &fsgrid);

      virtual void setupBeforeSetCell(const std::vector<CellID>& cells);

      void setCell(spatial_cell::SpatialCell* cell);
         
      virtual bool canRefine(spatial_cell::SpatialCell* cell) const;
 
      virtual bool shouldRefineCell(dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, CellID id, Real r_max2) const;
 
      virtual bool shouldUnrefineCell(dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, CellID id, Real r_max2) const;
 
      virtual bool refineSpatialCells( dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid ) const;

      virtual uint64_t adaptRefinement( dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid ) const;
 

      virtual bool forceRefinement( dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid, int n ) const;

      virtual bool filterRefined( dccrg::Dccrg<spatial_cell::SpatialCell,dccrg::Cartesian_Geometry>& mpiGrid ) const;
 
    protected:
      virtual uint findBlocksToInitialize(spatial_cell::SpatialCell* cell,const uint popID) const;
      
      void setVelocitySpace(const uint popID,spatial_cell::SpatialCell* cell) const;
         
      virtual void calcCellParameters(spatial_cell::SpatialCell* cell,creal& t);

      virtual Realf fillPhaseSpace(spatial_cell::SpatialCell *cell,
                                  const uint popID,
                                  const uint nRequested) const = 0;
 
      void printPopulations();
      
      virtual bool rescalesDensity(const uint popID) const;
      void rescaleDensity(spatial_cell::SpatialCell* cell,const uint popID) const;
      
      Real getRandomNumber(std::default_random_engine& randGen) const;

      void setRandomSeed(uint64_t seedModifier, std::default_random_engine& randGen) const;

      void setRandomCellSeed(spatial_cell::SpatialCell* cell, std::default_random_engine& randGen) const;
      
    private:
      uint seed;
      static char rngStateBuffer[256];
 
      bool baseClassInitialized;                      
   };
   
   Project* createProject();
} // namespace projects
 
 
#endif