Magnetosphere.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 MAGNETOSPHERE_H
#define MAGNETOSPHERE_H
 
#include "../../definitions.h"
#include "../../sysboundary/sysboundary.h"
#include "../projectTriAxisSearch.h"
 
namespace projects {
 
   struct MagnetosphereSpeciesParameters {
      Real rho;
      Real T;
      Real V0[3];
      Real ionosphereV0[3];
      Real ionosphereRho;
      Real ionosphereT;
      Real taperInnerRadius;
      Real taperOuterRadius;
   };
 
   class Magnetosphere: public TriAxisSearch {
    public:
      Magnetosphere();
      virtual ~Magnetosphere();
 
      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 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;
 
      bool
      refineSpatialCells(dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid) const override;
      bool forceRefinement(dccrg::Dccrg<spatial_cell::SpatialCell, dccrg::Cartesian_Geometry>& mpiGrid,
                           int n) const override;
      Real geometryRadius(Real x, Real y, Real z) const;
      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;
 
      std::array<Real, 3> constBgB;
      bool noDipoleInSW;
      Real ionosphereRadius;
      uint ionosphereGeometry;
      Real center[3];
      Real dipoleScalingFactor;
      Real dipoleMirrorLocationX;
      uint dipoleType;
 
      Real refine_L4radius;
      Real refine_L4nosexmin;
 
      Real refine_L3radius;
      Real refine_L3nosexmin;
      Real refine_L3tailheight;
      Real refine_L3tailwidth;
      Real refine_L3tailxmin;
      Real refine_L3tailxmax;
 
      Real refine_L2radius;
      Real refine_L2tailthick;
      Real refine_L1radius;
      Real refine_L1tailthick;
 
      Real dipoleTiltPhi;
      Real dipoleTiltTheta;
      Real dipoleXFull;
      Real dipoleXZero;
      Real dipoleInflowB[3];
      
      //GG 28.5.26: Adding first-pass of dipole offset code. Assuming SI units + guessing what the params will be named in cfg
      //No reason the offsets can't be a vector I don't think, but leaving separate for now as it already exists like this.
      Real dipoleXOffset;
      Real dipoleYOffset;
      Real dipoleZOffset;
 
      Real zeroOutComponents[3]; //0->x,1->y,2->z
 
      std::vector<MagnetosphereSpeciesParameters> speciesParams;
   }; // class Magnetosphere
} // namespace projects
 
#endif