#include <particle_species.h>
Public Member Functions | |
| Species () | |
| Species (const Species &other) | |
| ~Species () | |
Public Attributes | |
| 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 |
Detailed Description
Variables common to a particle species.
Definition at line 44 of file particle_species.h.
Constructor & Destructor Documentation
◆ Species() [1/2]
| species::Species::Species | ( | ) |
◆ Species() [2/2]
| species::Species::Species | ( | const Species & | other | ) |
◆ ~Species()
| species::Species::~Species | ( | ) |
Definition at line 34 of file particle_species.cpp.
Member Data Documentation
◆ charge
| Real species::Species::charge |
Particle species charge, in simulation units.
Definition at line 46 of file particle_species.h.
◆ EnergyDensityLimit1
| Real species::Species::EnergyDensityLimit1 |
Lower bound for second Energy density bin in units of solar wind ram energy. Default 5.
Definition at line 62 of file particle_species.h.
◆ EnergyDensityLimit2
| Real species::Species::EnergyDensityLimit2 |
Lower bound forthird Energy density bin in units of solar wind ram energy. Default 10.
Definition at line 63 of file particle_species.h.
◆ mass
| Real species::Species::mass |
Particle species mass, in simulation units.
Definition at line 47 of file particle_species.h.
◆ name
| std::string species::Species::name |
Name of the species.
Definition at line 45 of file particle_species.h.
◆ precipitationEmax
| Real species::Species::precipitationEmax |
Highest energy channel (in keV) for precipitation differential flux evaluation. Default 100.
Definition at line 69 of file particle_species.h.
◆ precipitationEmin
| Real species::Species::precipitationEmin |
Lowest energy channel (in keV) for precipitation differential flux evaluation. Default 0.1.
Definition at line 68 of file particle_species.h.
◆ precipitationLossConeAngle
| Real species::Species::precipitationLossConeAngle |
Fixed loss cone opening angle (in deg) for precipitation differential flux evaluation. Default 10.
Definition at line 70 of file particle_species.h.
◆ precipitationNChannels
| int species::Species::precipitationNChannels |
Number of energy channels for precipitation differential flux evaluation. Default 16.
Definition at line 67 of file particle_species.h.
◆ SolarWindEnergy
| Real species::Species::SolarWindEnergy |
Solar wind ram energy, used for calculating energy density bins. Default value of 0 attempts to use SolarWindSpeed instead.
Definition at line 64 of file particle_species.h.
◆ SolarWindSpeed
| Real species::Species::SolarWindSpeed |
Solar wind speed, used for calculating energy density bins if solar wind ram energy wasn't given. Default 0.
Definition at line 65 of file particle_species.h.
◆ sparse_conserve_mass
| bool species::Species::sparse_conserve_mass |
If true, density is scaled to conserve mass when removing blocks
Definition at line 52 of file particle_species.h.
◆ sparseBlockAddWidthV
| int species::Species::sparseBlockAddWidthV |
Number of layers of blocks that are kept in velocity space around the blocks with content
Definition at line 51 of file particle_species.h.
◆ sparseDynamicAlgorithm
| int species::Species::sparseDynamicAlgorithm |
Type of algorithm used for calculating the dynamic minValue; 0 = none, 1 = linear algorithm based on minValue and rho, 2 = linear algorithm based on minValue and Blocks, (Example linear algorithm: minValue = rho / sparse.dynamicValue * sparse.minValue)
Definition at line 53 of file particle_species.h.
◆ sparseDynamicBulkValue1
| Real species::Species::sparseDynamicBulkValue1 |
Minimum value for the dynamic algorithm range, so for example if dynamicAlgorithm=1 then for sparse.dynamicMinValue = 1e3, sparse.dynamicMaxValue=1e5, we apply the algorithm to cells for which 1e3<cell.rho<1e5
Definition at line 54 of file particle_species.h.
◆ sparseDynamicBulkValue2
| Real species::Species::sparseDynamicBulkValue2 |
Maximum value for the dynamic algorithm range, so for example if dynamicAlgorithm=1 then for sparse.dynamicMinValue = 1e3, sparse.dynamicMaxValue=1e5, we apply the algorithm to cells for which 1e3<cell.rho<1e5
Definition at line 55 of file particle_species.h.
◆ sparseDynamicMinValue1
| Real species::Species::sparseDynamicMinValue1 |
The minimum value for the minValue
Definition at line 56 of file particle_species.h.
◆ sparseDynamicMinValue2
| Real species::Species::sparseDynamicMinValue2 |
The maximum value for the minValue
Definition at line 57 of file particle_species.h.
◆ sparseMinValue
| Real species::Species::sparseMinValue |
Sparse mesh threshold value for the population.
Definition at line 48 of file particle_species.h.
◆ thermalRadius
| Real species::Species::thermalRadius |
Radius of sphere to split the distribution into thermal and suprathermal. 0 (default in cfg) disables the DRO.
Definition at line 59 of file particle_species.h.
◆ thermalV
| std::array<Real, 3> species::Species::thermalV |
Centre of sphere to split the distribution into thermal and suprathermal. 0 (default in cfg) disables the DRO.
Definition at line 60 of file particle_species.h.
◆ velocityMesh
| size_t species::Species::velocityMesh |
ID of the velocity mesh (parameters) this species uses.
Definition at line 49 of file particle_species.h.
The documentation for this struct was generated from the following files:
