Vlasiator ebf0dd394 on dev (v5.4.0 + 1054 commits)
Loading...
Searching...
No Matches
Parameters Struct Reference

#include <parameters.h>

Public Types

enum  ASTERIX_COMPRESSION_METHODS {
  NONE , ZFP , OCTREE , MLP ,
  MLP_MULTI
}

Static Public Member Functions

static bool addParameters ()
 Add the global parameters.
static void getParameters ()
 Get the global parameters.

Static Public Attributes

static Real xmin = NAN
static Real xmax = NAN
static Real ymin = NAN
static Real ymax = NAN
static Real zmin = NAN
static Real zmax = NAN
static Real dx_ini = NAN
static Real dy_ini = NAN
static Real dz_ini = NAN
static uint xcells_ini = numeric_limits<uint>::max()
static uint ycells_ini = numeric_limits<uint>::max()
static uint zcells_ini = numeric_limits<uint>::max()
static Real t = 0
static Real t_min = 0
static Real t_max = LARGE_REAL
static Real dt = NAN
static Real dt_ceil = -1.0
static Real vlasovSolverMaxCFL = NAN
static Real vlasovSolverMinCFL = NAN
static bool vlasovSolverGhostTranslate = false
static uint vlasovSolverGhostTranslateExtent = 0
static Real fieldSolverMinCFL = NAN
static Real fieldSolverMaxCFL = NAN
static uint fieldSolverSubcycles = 1
static uint tstep_min = 0
static uint tstep_max = 0
static uint tstep = 0
static bool meshRepartitioned = true
static std::vector< CellID > localCells
static bool adaptGPUWID = true
static uint GPUallocations = 128
static uint diagnosticInterval = numeric_limits<uint>::max()
static std::vector< std::string > systemWriteName
static std::vector< std::string > systemWritePath
static std::vector< Real > systemWriteTimeInterval
static std::vector< int > systemWriteDistributionWriteStride
static bool systemWriteDistributionCompressed
static bool systemWriteRestartCompressed
static bool systemWriteRecoveryCompressed
static std::vector< int > systemWriteDistributionWriteXlineStride
static std::vector< int > systemWriteDistributionWriteYlineStride
static std::vector< int > systemWriteDistributionWriteZlineStride
static std::vector< Real > systemWriteDistributionWriteShellRadius
static std::vector< int > systemWriteDistributionWriteShellStride
static std::vector< bool > systemWriteFsGrid
static bool systemWriteAllDROs
static bool diagnosticWriteAllDROs
static std::vector< int > systemWrites
static std::vector< std::pair< std::string, std::string > > systemWriteHints
static std::vector< std::pair< std::string, std::string > > restartReadHints
static std::vector< std::pair< std::string, std::string > > restartWriteHints
static bool writeInitialState = true
static bool writeFullBGB = false
static Real saveRestartWalltimeInterval = -1.0
static uint saveRecoverTstepInterval = 0
static uint exitAfterRestarts = numeric_limits<uint>::max()
static uint recoverMaxFiles = 0
static uint64_t vlsvBufferSize = 0
static int restartStripeFactor = 0
static int systemStripeFactor = 0
static std::string restartWritePath = string("")
static std::string recoverWritePath = string("")
static bool recalculateStencils = true
static bool propagateField = true
static bool propagateVlasovAcceleration = true
static bool propagateVlasovTranslation = true
static Real maxWaveVelocity = 0.0
static uint maxFieldSolverSubcycles = 0.0
static Real resistivity = NAN
static uint ohmHallTerm = 0
static uint ohmGradPeTerm = 0
static Real electronTemperature = 0.0
static Real electronDensity = 0.0
static Real electronPTindex = 1.0
static bool fieldSolverDiffusiveEterms = true
static bool fieldSolverFiniteDifferencingAtBoundaries = false
static Real maxSlAccelerationRotation = 10.0
static int maxSlAccelerationSubcycles = 0.0
static bool vlasovAccelerateMaxwellianBoundaries = false
static Real hallMinimumRhom = physicalconstants::MASS_PROTON
static Real hallMinimumRhoq = physicalconstants::CHARGE
static std::string loadBalanceAlgorithm = string("")
static std::map< std::string, std::string > loadBalanceOptions
static uint rebalanceInterval = numeric_limits<uint>::max()
static bool prepareForRebalance = false
static std::vector< std::string > outputVariableList
static std::vector< std::string > diagnosticVariableList
static std::string restartFileName = string("")
static bool isRestart = false
static int writeAsFloat = false
static int writeRestartAsFloat = false
static bool dynamicTimestep = true
static std::string projectName = string("")
static bool bailout_write_restart = false
static Real bailout_min_dt = NAN
static Real bailout_max_memory = 1073741824.
static uint bailout_velocity_space_wall_margin = 0
static int amrMaxSpatialRefLevel = 0
static int amrMaxAllowedSpatialRefLevel = -1
static bool adaptRefinement = false
static bool refineOnRestart = false
static bool forceRefinement = false
static bool shouldFilter = false
static bool useAlpha1 = true
static Real alpha1RefineThreshold = 0.5
static Real alpha1CoarsenThreshold = -1.0
static bool useAlpha2 = true
static Real alpha2RefineThreshold = 0.5
static Real alpha2CoarsenThreshold = -1.0
static bool useVorticity = false
static Real vorticityRefineThreshold = 0.5
static Real vorticityCoarsenThreshold = -1.0
static bool useAnisotropy = false
static Real anisotropyRefineThreshold = 0.5
static Real anisotropyCoarsenThreshold = -1.0
static int anisotropyMaxReflevel = 2
static uint refineCadence = 5
static Real refineAfter = 0.0
static Real refineRadius = LARGE_REAL
static Real alphaDRhoWeight = 1.0
static Real alphaDUWeight = 1.0
static Real alphaDPSqWeight = 1.0
static Real alphaDBSqWeight = 1.0
static Real alphaDBWeight = 1.0
static int refineBoxNumber = 0
static std::vector< Real > refinementMinX
static std::vector< Real > refinementMinY
static std::vector< Real > refinementMinZ
static std::vector< Real > refinementMaxX
static std::vector< Real > refinementMaxY
static std::vector< Real > refinementMaxZ
static int maxFilteringPasses = 0
static int amrBoxNumber = 0
static std::vector< uint > amrBoxHalfWidthX
static std::vector< uint > amrBoxHalfWidthY
static std::vector< uint > amrBoxHalfWidthZ
static std::vector< Realf > amrBoxCenterX
static std::vector< Realf > amrBoxCenterY
static std::vector< Realf > amrBoxCenterZ
static std::vector< int > amrBoxMaxLevel
static bool amrTransShortPencils = false
static std::vector< std::string > blurPassString
static std::vector< int > numPasses
static bool artificialPADiff
static Realf PADcoefficient
static Realf PADCFL
static int PADvbins
static int PADmubins
static std::string PADnu0 = string("")
static Realf PADfudge
static std::array< fsgrid::Task_t, 3 > manualFsGridDecomposition = {0,0,0}
static std::array< fsgrid::Task_t, 3 > overrideReadFsGridDecomposition = {0,0,0}
static std::string mlpLayer
static std::vector< std::size_t > mlp_arch
static std::size_t mlp_fourier_order
static std::size_t mlp_max_epochs
static Real compression_interval
static Real mlp_tollerance
static std::size_t max_vdfs_per_nn
static Real octree_tolerance
static bool doCompress =false
static std::string method_str
static ASTERIX_COMPRESSION_METHODS vdf_compression_method
static bool computeCurvature

Detailed Description

Definition at line 37 of file parameters.h.

Member Enumeration Documentation

◆ ASTERIX_COMPRESSION_METHODS

enum Parameters::ASTERIX_COMPRESSION_METHODS
Enumerator
NONE 
ZFP 
OCTREE 
MLP 
MLP_MULTI 

Definition at line 249 of file parameters.h.

Member Function Documentation

◆ addParameters()

bool P::addParameters ( )
static

Add the global parameters.

This function adds all the parameters that are loaded at a global level. More are being loaded e.g. in the projects and in the system boundary conditions.

Note that due to the large number of parameters added here, no code is added to check for consistency when they are read later. Please make sure when coding new parameters here that the options in getParameters match the ones added here.

See also
getParameters

Definition at line 244 of file parameters.cpp.

Here is the caller graph for this function:

◆ getParameters()

void Parameters::getParameters ( )
static

Get the global parameters.

This function gets all the parameters loaded at a global level. More are being loaded e.g. in the projects and in the system boundary conditions.

Note that due to the large number of parameters read here, no code is added to check for consistency with the loaded options, or the code here would become much less readable. Please make sure when coding new parameters here that the options in addParameters match the ones read here.

Parameters
firstPassdetermines whether to only parse out particle populations (first pass), to parse all other parameters.
See also
addParameters

Definition at line 608 of file parameters.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ adaptGPUWID

bool P::adaptGPUWID = true
static

If true, GPU runs with WID=8 use halved velocity block counts.

Definition at line 78 of file parameters.h.

◆ adaptRefinement

bool P::adaptRefinement = false
static

Definition at line 192 of file parameters.h.

◆ alpha1CoarsenThreshold

Real P::alpha1CoarsenThreshold = -1.0
static

Definition at line 198 of file parameters.h.

◆ alpha1RefineThreshold

Real P::alpha1RefineThreshold = 0.5
static

Definition at line 197 of file parameters.h.

◆ alpha2CoarsenThreshold

Real P::alpha2CoarsenThreshold = -1.0
static

Definition at line 201 of file parameters.h.

◆ alpha2RefineThreshold

Real P::alpha2RefineThreshold = 0.5
static

Definition at line 200 of file parameters.h.

◆ alphaDBSqWeight

Real P::alphaDBSqWeight = 1.0
static

Definition at line 216 of file parameters.h.

◆ alphaDBWeight

Real P::alphaDBWeight = 1.0
static

Definition at line 217 of file parameters.h.

◆ alphaDPSqWeight

Real P::alphaDPSqWeight = 1.0
static

Definition at line 215 of file parameters.h.

◆ alphaDRhoWeight

Real P::alphaDRhoWeight = 1.0
static

Definition at line 213 of file parameters.h.

◆ alphaDUWeight

Real P::alphaDUWeight = 1.0
static

Definition at line 214 of file parameters.h.

◆ amrBoxCenterX

std::vector< Realf > P::amrBoxCenterX
static

Definition at line 230 of file parameters.h.

◆ amrBoxCenterY

std::vector< Realf > P::amrBoxCenterY
static

Definition at line 231 of file parameters.h.

◆ amrBoxCenterZ

std::vector< Realf > P::amrBoxCenterZ
static

Definition at line 232 of file parameters.h.

◆ amrBoxHalfWidthX

std::vector< uint > P::amrBoxHalfWidthX
static

Definition at line 227 of file parameters.h.

◆ amrBoxHalfWidthY

std::vector< uint > P::amrBoxHalfWidthY
static

Definition at line 228 of file parameters.h.

◆ amrBoxHalfWidthZ

std::vector< uint > P::amrBoxHalfWidthZ
static

Definition at line 229 of file parameters.h.

◆ amrBoxMaxLevel

std::vector< int > P::amrBoxMaxLevel
static

Definition at line 233 of file parameters.h.

◆ amrBoxNumber

int P::amrBoxNumber = 0
static

Definition at line 226 of file parameters.h.

◆ amrMaxAllowedSpatialRefLevel

int P::amrMaxAllowedSpatialRefLevel = -1
static

Maximum currently allowed refinement level for restart or dynamic refinement.

Definition at line 191 of file parameters.h.

◆ amrMaxSpatialRefLevel

int P::amrMaxSpatialRefLevel = 0
static

Absolute maximum refinement level (conditions the fsgrid resolution), cannot be exceeded after initial setup of the grids.

Definition at line 190 of file parameters.h.

◆ amrTransShortPencils

bool P::amrTransShortPencils = false
static

Use short or long pencils in AMR translation.

Definition at line 234 of file parameters.h.

◆ anisotropyCoarsenThreshold

Real P::anisotropyCoarsenThreshold = -1.0
static

Definition at line 208 of file parameters.h.

◆ anisotropyMaxReflevel

int P::anisotropyMaxReflevel = 2
static

Definition at line 209 of file parameters.h.

◆ anisotropyRefineThreshold

Real P::anisotropyRefineThreshold = 0.5
static

Definition at line 207 of file parameters.h.

◆ artificialPADiff

bool P::artificialPADiff
static

Definition at line 237 of file parameters.h.

◆ bailout_max_memory

Real P::bailout_max_memory = 1073741824.
static

Maximum amount of memory used per node (in GiB) over which bailout occurs.

Definition at line 187 of file parameters.h.

◆ bailout_min_dt

Real P::bailout_min_dt = NAN
static

Minimum time step below which bailout occurs (s).

Definition at line 186 of file parameters.h.

◆ bailout_velocity_space_wall_margin

uint P::bailout_velocity_space_wall_margin = 0
static

Safety margin in number of blocks off the v-space wall beyond which bailout occurs.

Definition at line 188 of file parameters.h.

◆ bailout_write_restart

bool P::bailout_write_restart = false
static

If true, write a restart file on bailout. Gets reset when sending a STOP (true) or a KILL (false).

Definition at line 184 of file parameters.h.

◆ blurPassString

vector< string > P::blurPassString
static

Definition at line 235 of file parameters.h.

◆ compression_interval

Real P::compression_interval
static

Definition at line 260 of file parameters.h.

◆ computeCurvature

bool P::computeCurvature
static

Definition at line 268 of file parameters.h.

◆ diagnosticInterval

uint P::diagnosticInterval = numeric_limits<uint>::max()
static

Definition at line 81 of file parameters.h.

◆ diagnosticVariableList

vector< string > P::diagnosticVariableList
static

List of data reduction operators (DROs) to add to the diagnostic runtime output.

Definition at line 173 of file parameters.h.

◆ diagnosticWriteAllDROs

bool P::diagnosticWriteAllDROs
static

Write all diagnostic DROs or not.

Definition at line 107 of file parameters.h.

◆ doCompress

bool P::doCompress =false
static

Definition at line 264 of file parameters.h.

◆ dt

Real P::dt = NAN
static

The value of the timestep to use in propagation. If CflLimit defined then it is dynamically updated during simulation

Definition at line 55 of file parameters.h.

◆ dt_ceil

Real P::dt_ceil = -1.0
static

The maximum value of the timestep to use in propagation.

Definition at line 57 of file parameters.h.

◆ dx_ini

Real P::dx_ini = NAN
static

Initial size of spatial cell in x-direction.

Definition at line 44 of file parameters.h.

◆ dy_ini

Real P::dy_ini = NAN
static

Initial size of spatial cell in y-direction.

Definition at line 45 of file parameters.h.

◆ dynamicTimestep

bool P::dynamicTimestep = true
static

If true, timestep is set based on CFL limit

Definition at line 180 of file parameters.h.

◆ dz_ini

Real P::dz_ini = NAN
static

Initial size of spatial cell in z-direction.

Definition at line 46 of file parameters.h.

◆ electronDensity

Real P::electronDensity = 0.0
static

Upstream electron density to be used for the electron pressure gradient term (m^-3).

Definition at line 149 of file parameters.h.

◆ electronPTindex

Real P::electronPTindex = 1.0
static

Definition at line 150 of file parameters.h.

◆ electronTemperature

Real P::electronTemperature = 0.0
static

Upstream electron temperature to be used for the electron pressure gradient term (K).

Definition at line 146 of file parameters.h.

◆ exitAfterRestarts

uint P::exitAfterRestarts = numeric_limits<uint>::max()
static

Exit after this many restarts

Definition at line 121 of file parameters.h.

◆ fieldSolverDiffusiveEterms

bool P::fieldSolverDiffusiveEterms = true
static

Polytropic index for electron pressure gradient term. 0 is isobaric, 1 is isothermal, 1.667 is adiabatic electrons

Enable resistive terms in the computation of E

Definition at line 153 of file parameters.h.

◆ fieldSolverFiniteDifferencingAtBoundaries

bool P::fieldSolverFiniteDifferencingAtBoundaries = false
static

Enable finite differencing at sysboundaries

Definition at line 154 of file parameters.h.

◆ fieldSolverMaxCFL

Real P::fieldSolverMaxCFL = NAN
static

The maximum CFL limit for propagation of fields. Used to set timestep if useCFLlimit is true.

Definition at line 67 of file parameters.h.

◆ fieldSolverMinCFL

Real P::fieldSolverMinCFL = NAN
static

The minimum CFL limit for propagation of fields. Used to set timestep if useCFLlimit is true.

Definition at line 65 of file parameters.h.

◆ fieldSolverSubcycles

uint P::fieldSolverSubcycles = 1
static

The number of field solver subcycles to compute.

Definition at line 69 of file parameters.h.

◆ forceRefinement

bool P::forceRefinement = false
static

Definition at line 194 of file parameters.h.

◆ GPUallocations

uint P::GPUallocations = 128
static

How many parallel GPU vlasov allocations to make?

Definition at line 79 of file parameters.h.

◆ hallMinimumRhom

Real P::hallMinimumRhom = physicalconstants::MASS_PROTON
static

Minimum mass density value used in the field solver.

Definition at line 160 of file parameters.h.

◆ hallMinimumRhoq

Real P::hallMinimumRhoq = physicalconstants::CHARGE
static

Minimum charge density value used for the Hall and electron pressure gradient terms in the Lorentz force and in the field solver.

Definition at line 161 of file parameters.h.

◆ isRestart

bool P::isRestart = false
static

true if this is a restart, false otherwise

Definition at line 176 of file parameters.h.

◆ loadBalanceAlgorithm

string P::loadBalanceAlgorithm = string("")
static

Algorithm to be used for load balance.

Definition at line 164 of file parameters.h.

◆ loadBalanceOptions

std::map< std::string, std::string > P::loadBalanceOptions
static

Definition at line 165 of file parameters.h.

◆ localCells

vector< CellID > P::localCells
static

Cached copy of spatial cell IDs on this process.

Definition at line 76 of file parameters.h.

◆ manualFsGridDecomposition

std::array< fsgrid::Task_t, 3 > P::manualFsGridDecomposition = {0,0,0}
static

Definition at line 245 of file parameters.h.

◆ max_vdfs_per_nn

std::size_t P::max_vdfs_per_nn
static

Definition at line 262 of file parameters.h.

◆ maxFieldSolverSubcycles

uint P::maxFieldSolverSubcycles = 0.0
static

Maximum allowed field solver subcycles.

Definition at line 140 of file parameters.h.

◆ maxFilteringPasses

int P::maxFilteringPasses = 0
static

Definition at line 225 of file parameters.h.

◆ maxSlAccelerationRotation

Real P::maxSlAccelerationRotation = 10.0
static

Maximum rotation in acceleration for semilagrangian solver

Definition at line 156 of file parameters.h.

◆ maxSlAccelerationSubcycles

int P::maxSlAccelerationSubcycles = 0.0
static

Maximum number of subcycles in acceleration

Definition at line 157 of file parameters.h.

◆ maxWaveVelocity

Real P::maxWaveVelocity = 0.0
static

Maximum wave velocity allowed in LDZ.

Definition at line 139 of file parameters.h.

◆ meshRepartitioned

bool P::meshRepartitioned = true
static

If true, mesh was repartitioned on this time step.

Definition at line 75 of file parameters.h.

◆ method_str

std::string P::method_str
static

Definition at line 265 of file parameters.h.

◆ mlp_arch

std::vector< std::size_t > P::mlp_arch
static

Definition at line 257 of file parameters.h.

◆ mlp_fourier_order

std::size_t P::mlp_fourier_order
static

Definition at line 258 of file parameters.h.

◆ mlp_max_epochs

std::size_t P::mlp_max_epochs
static

Definition at line 259 of file parameters.h.

◆ mlp_tollerance

Real P::mlp_tollerance
static

Definition at line 261 of file parameters.h.

◆ mlpLayer

std::string P::mlpLayer
static

Definition at line 256 of file parameters.h.

◆ numPasses

vector< int > P::numPasses
static

Definition at line 236 of file parameters.h.

◆ octree_tolerance

Real P::octree_tolerance
static

Definition at line 263 of file parameters.h.

◆ ohmGradPeTerm

uint P::ohmGradPeTerm = 0
static

Enable/choose spatial order of the electron pressure gradient term in Ohm's law. 0: off, 1: 1st spatial order.

Definition at line 144 of file parameters.h.

◆ ohmHallTerm

uint P::ohmHallTerm = 0
static

Enable/choose spatial order of Hall term in Ohm's law JXB term. 0: off, 1: 1st spatial order, 2: 2nd spatial order.

Definition at line 142 of file parameters.h.

◆ outputVariableList

vector< string > P::outputVariableList
static

List of data reduction operators (DROs) to add to the grid file output.

Definition at line 171 of file parameters.h.

◆ overrideReadFsGridDecomposition

std::array< fsgrid::Task_t, 3 > P::overrideReadFsGridDecomposition = {0,0,0}
static

Definition at line 246 of file parameters.h.

◆ PADCFL

Realf P::PADCFL
static

Definition at line 239 of file parameters.h.

◆ PADcoefficient

Realf P::PADcoefficient
static

Definition at line 238 of file parameters.h.

◆ PADfudge

Realf P::PADfudge
static

Definition at line 243 of file parameters.h.

◆ PADmubins

int P::PADmubins
static

Definition at line 241 of file parameters.h.

◆ PADnu0

string P::PADnu0 = string("")
static

Definition at line 242 of file parameters.h.

◆ PADvbins

int P::PADvbins
static

Definition at line 240 of file parameters.h.

◆ prepareForRebalance

bool P::prepareForRebalance = false
static

If true, propagators should measure their time consumption in preparation for mesh repartitioning.

Definition at line 167 of file parameters.h.

◆ projectName

string P::projectName = string("")
static

Project to be used in this run.

Definition at line 182 of file parameters.h.

◆ propagateField

bool P::propagateField = true
static

If true, magnetic field is propagated during the simulation.

Definition at line 133 of file parameters.h.

◆ propagateVlasovAcceleration

bool P::propagateVlasovAcceleration = true
static

If true, distribution function is propagated in velocity space during the simulation.

Definition at line 134 of file parameters.h.

◆ propagateVlasovTranslation

bool P::propagateVlasovTranslation = true
static

If true, distribution function is propagated in ordinary space during the simulation.

Definition at line 136 of file parameters.h.

◆ rebalanceInterval

uint P::rebalanceInterval = numeric_limits<uint>::max()
static

Load rebalance interval (steps).

Definition at line 166 of file parameters.h.

◆ recalculateStencils

bool P::recalculateStencils = true
static

If true, MPI stencils should be recalculated because of load balancing.

Definition at line 131 of file parameters.h.

◆ recoverMaxFiles

uint P::recoverMaxFiles = 0
static

Definition at line 122 of file parameters.h.

◆ recoverWritePath

string P::recoverWritePath = string("")
static

Path to the location where recover files should be written. Defaults to the local directory, also if the specified destination is not writeable.

Definition at line 128 of file parameters.h.

◆ refineAfter

Real P::refineAfter = 0.0
static

Definition at line 211 of file parameters.h.

◆ refineBoxNumber

int P::refineBoxNumber = 0
static

Definition at line 218 of file parameters.h.

◆ refineCadence

uint P::refineCadence = 5
static

Definition at line 210 of file parameters.h.

◆ refinementMaxX

std::vector< Real > P::refinementMaxX
static

Do not refine at x coordinates above this value.

Definition at line 222 of file parameters.h.

◆ refinementMaxY

std::vector< Real > P::refinementMaxY
static

Do not refine at y coordinates above this value.

Definition at line 223 of file parameters.h.

◆ refinementMaxZ

std::vector< Real > P::refinementMaxZ
static

Do not refine at z coordinates above this value.

Definition at line 224 of file parameters.h.

◆ refinementMinX

std::vector< Real > P::refinementMinX
static

Do not refine at x coordinates below this value.

Definition at line 219 of file parameters.h.

◆ refinementMinY

std::vector< Real > P::refinementMinY
static

Do not refine at y coordinates below this value.

Definition at line 220 of file parameters.h.

◆ refinementMinZ

std::vector< Real > P::refinementMinZ
static

Do not refine at z coordinates below this value.

Definition at line 221 of file parameters.h.

◆ refineOnRestart

bool P::refineOnRestart = false
static

Definition at line 193 of file parameters.h.

◆ refineRadius

Real P::refineRadius = LARGE_REAL
static

Definition at line 212 of file parameters.h.

◆ resistivity

Real P::resistivity = NAN
static

Resistivity in Ohm's law eta*J term.

Definition at line 141 of file parameters.h.

◆ restartFileName

string P::restartFileName = string("")
static

If defined, restart from this file

Definition at line 175 of file parameters.h.

◆ restartReadHints

vector< pair< string, string > > P::restartReadHints
static

Collection of MPI-IO hints passed for restart IO. Pairs of key-value strings.

Definition at line 112 of file parameters.h.

◆ restartStripeFactor

int P::restartStripeFactor = 0
static

stripe_factor for restart writing

Definition at line 124 of file parameters.h.

◆ restartWriteHints

vector< pair< string, string > > P::restartWriteHints
static

Collection of MPI-IO hints passed for restart IO. Pairs of key-value strings.

Definition at line 114 of file parameters.h.

◆ restartWritePath

string P::restartWritePath = string("")
static

Path to the location where restart files should be written. Defaults to the local directory, also if the specified destination is not writeable.

Definition at line 126 of file parameters.h.

◆ saveRecoverTstepInterval

uint P::saveRecoverTstepInterval = 0
static

Interval in timesteps for recover data

Definition at line 120 of file parameters.h.

◆ saveRestartWalltimeInterval

Real P::saveRestartWalltimeInterval = -1.0
static

Interval in walltime seconds for restart data

Definition at line 119 of file parameters.h.

◆ shouldFilter

bool P::shouldFilter = false
static

Definition at line 195 of file parameters.h.

◆ systemStripeFactor

int P::systemStripeFactor = 0
static

stripe_factor for bulk and initial grid writing

Definition at line 125 of file parameters.h.

◆ systemWriteAllDROs

bool P::systemWriteAllDROs
static

Write all output DROs or not.

Definition at line 106 of file parameters.h.

◆ systemWriteDistributionCompressed

bool P::systemWriteDistributionCompressed
static

Definition at line 87 of file parameters.h.

◆ systemWriteDistributionWriteShellRadius

vector< Real > P::systemWriteDistributionWriteShellRadius
static

At cells intersecting spheres with those radii centred at the origin write out their velocity space in each class.

Definition at line 100 of file parameters.h.

◆ systemWriteDistributionWriteShellStride

vector< int > P::systemWriteDistributionWriteShellStride
static

Every this many cells for those on selected shells write out their velocity space in each class.

Definition at line 103 of file parameters.h.

◆ systemWriteDistributionWriteStride

vector< int > P::systemWriteDistributionWriteStride
static

Every this many cells write out their velocity space in each class.

Definition at line 86 of file parameters.h.

◆ systemWriteDistributionWriteXlineStride

vector< int > P::systemWriteDistributionWriteXlineStride
static

Every this many lines of cells along the x direction write out their velocity space in each class.

Definition at line 91 of file parameters.h.

◆ systemWriteDistributionWriteYlineStride

vector< int > P::systemWriteDistributionWriteYlineStride
static

Every this many lines of cells along the y direction write out their velocity space in each class.

Definition at line 94 of file parameters.h.

◆ systemWriteDistributionWriteZlineStride

vector< int > P::systemWriteDistributionWriteZlineStride
static

Every this many lines of cells along the z direction write out their velocity space in each class.

Definition at line 97 of file parameters.h.

◆ systemWriteFsGrid

vector< bool > P::systemWriteFsGrid
static

Write fg_ variables in this file class or not.

Definition at line 105 of file parameters.h.

◆ systemWriteHints

vector< pair< string, string > > P::systemWriteHints
static

Collection of MPI-IO hints passed for non-restart IO. Pairs of key-value strings.

Definition at line 110 of file parameters.h.

◆ systemWriteName

vector< string > P::systemWriteName
static

Names for the different classes of grid output

Definition at line 82 of file parameters.h.

◆ systemWritePath

vector< string > P::systemWritePath
static

Save this series in this location. Default is ./

Definition at line 83 of file parameters.h.

◆ systemWriteRecoveryCompressed

bool P::systemWriteRecoveryCompressed
static

Definition at line 89 of file parameters.h.

◆ systemWriteRestartCompressed

bool P::systemWriteRestartCompressed
static

Definition at line 88 of file parameters.h.

◆ systemWrites

vector< int > P::systemWrites
static

How many files have been written of each class

Definition at line 108 of file parameters.h.

◆ systemWriteTimeInterval

vector< Real > P::systemWriteTimeInterval
static

Interval in simusecond for output for each class

Definition at line 84 of file parameters.h.

◆ t

Real P::t = 0
static

Current simulation time.

Definition at line 52 of file parameters.h.

◆ t_max

Real P::t_max = LARGE_REAL
static

Maximum simulation time.

Definition at line 54 of file parameters.h.

◆ t_min

Real P::t_min = 0
static

Initial simulation time.

Definition at line 53 of file parameters.h.

◆ tstep

uint P::tstep = 0
static

The number of the current timestep. 0=initial state.

Definition at line 73 of file parameters.h.

◆ tstep_max

uint P::tstep_max = 0
static

Maximum timestep.

Definition at line 72 of file parameters.h.

◆ tstep_min

uint P::tstep_min = 0
static

Timestep when simulation starts, needed for restarts.

Definition at line 71 of file parameters.h.

◆ useAlpha1

bool P::useAlpha1 = true
static

Definition at line 196 of file parameters.h.

◆ useAlpha2

bool P::useAlpha2 = true
static

Definition at line 199 of file parameters.h.

◆ useAnisotropy

bool P::useAnisotropy = false
static

Definition at line 206 of file parameters.h.

◆ useVorticity

bool P::useVorticity = false
static

Definition at line 203 of file parameters.h.

◆ vdf_compression_method

P::ASTERIX_COMPRESSION_METHODS P::vdf_compression_method
static

Definition at line 266 of file parameters.h.

◆ vlasovAccelerateMaxwellianBoundaries

bool P::vlasovAccelerateMaxwellianBoundaries = false
static

Accelerate also Maxwellian boundary cells

Definition at line 158 of file parameters.h.

◆ vlasovSolverGhostTranslate

bool P::vlasovSolverGhostTranslate = false
static

Flag for activating all-local ghost translation.

Definition at line 63 of file parameters.h.

◆ vlasovSolverGhostTranslateExtent

uint P::vlasovSolverGhostTranslateExtent = 0
static

Define extent of ghost-translated region in all-local ghost translation.

Definition at line 64 of file parameters.h.

◆ vlasovSolverMaxCFL

Real P::vlasovSolverMaxCFL = NAN
static

The maximum CFL limit for propagation of distribution function. Used to set timestep if useCFLlimit is true.

Definition at line 59 of file parameters.h.

◆ vlasovSolverMinCFL

Real P::vlasovSolverMinCFL = NAN
static

The minimum CFL limit for propagation of distribution function. Used to set timestep if useCFLlimit is true.

Definition at line 61 of file parameters.h.

◆ vlsvBufferSize

uint64_t P::vlsvBufferSize = 0
static

Buffer size in bytes passed to VLSV writer.

Definition at line 123 of file parameters.h.

◆ vorticityCoarsenThreshold

Real P::vorticityCoarsenThreshold = -1.0
static

Definition at line 205 of file parameters.h.

◆ vorticityRefineThreshold

Real P::vorticityRefineThreshold = 0.5
static

Definition at line 204 of file parameters.h.

◆ writeAsFloat

int P::writeAsFloat = false
static

true if writing into VLSV in floats instead of doubles, false otherwise

Definition at line 177 of file parameters.h.

◆ writeFullBGB

bool P::writeFullBGB = false
static

If true, write full BGB components and derivatives in a dedicated file, then exit.

Definition at line 118 of file parameters.h.

◆ writeInitialState

bool P::writeInitialState = true
static

If true, initial state is written. This is useful for debugging as the restarts are always written out after propagation of 0.5dt in real space.

Definition at line 116 of file parameters.h.

◆ writeRestartAsFloat

int P::writeRestartAsFloat = false
static

true if writing into restart files in floats instead of doubles, false otherwise

Definition at line 179 of file parameters.h.

◆ xcells_ini

uint P::xcells_ini = numeric_limits<uint>::max()
static

Initial number of spatial cells in x-direction.

Definition at line 48 of file parameters.h.

◆ xmax

Real P::xmax = NAN
static

X-coordinate of the upper right corner of the spatial grid.

Definition at line 39 of file parameters.h.

◆ xmin

Real P::xmin = NAN
static

X-coordinate of the lower left corner of the spatial grid.

Definition at line 38 of file parameters.h.

◆ ycells_ini

uint P::ycells_ini = numeric_limits<uint>::max()
static

Initial number of spatial cells in y-direction.

Definition at line 49 of file parameters.h.

◆ ymax

Real P::ymax = NAN
static

Y-coordinate of the upper right corner of the spatial grid.

Definition at line 41 of file parameters.h.

◆ ymin

Real P::ymin = NAN
static

Y-coordinate of the lower left corner of the spatial grid.

Definition at line 40 of file parameters.h.

◆ zcells_ini

uint P::zcells_ini = numeric_limits<uint>::max()
static

Initial number of spatial cells in z-direction.

Definition at line 50 of file parameters.h.

◆ zmax

Real P::zmax = NAN
static

Z-coordinate of the upper right corner of the spatial grid.

Definition at line 43 of file parameters.h.

◆ zmin

Real P::zmin = NAN
static

Z-coordinate of the lower left corner of the spatial grid.

Definition at line 42 of file parameters.h.

The documentation for this struct was generated from the following files: