particle_species.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.
 *
 * File:   particle_species.h
 * Author: sandroos
 *
 * Created on January 27, 2015.
 */
 
#ifndef PARTICLE_SPECIES_H
#define  PARTICLE_SPECIES_H
 
#include "definitions.h"
#include <array>
#include <string>
namespace species {
    
   // Aliases for the maximum dt values stored in spatial_cell::Population::max_dt array.
   enum Dt_Elements {
      MAXRDT,                           
      MAXVDT,                           
      SIZE_DT_ELEMENTS                  
   };
   
   struct Species {
      std::string name;               
      Real charge;                    
      Real mass;                      
      Real sparseMinValue;            
      size_t velocityMesh;            
 
      int sparseBlockAddWidthV;        
      bool sparse_conserve_mass;       
      int  sparseDynamicAlgorithm;     
      Real sparseDynamicBulkValue1;    
      Real sparseDynamicBulkValue2;    
      Real sparseDynamicMinValue1;     
      Real sparseDynamicMinValue2;     
 
      Real thermalRadius;           
      std::array<Real, 3> thermalV; 
 
      Real EnergyDensityLimit1;   
      Real EnergyDensityLimit2;   
      Real SolarWindEnergy;       
      Real SolarWindSpeed;        
 
      int precipitationNChannels;              
      Real precipitationEmin;                  
      Real precipitationEmax;                  
      Real precipitationLossConeAngle;         
 
      Species();
      Species(const Species& other);
      ~Species();
    };
 
} // namespace species
 
#endif   // PARTICLE_SPECIES_H