Top-level run control shared by initialization and the time loop. More...

#include "globals.hpp"

Collaboration diagram for orb5x::BasicVariables:

Public Attributes
Real	dt = 0.0
	Simulation step in normalized time units.
Real	extra_time = 0.0
	Wall-clock reserve for output and shutdown, in seconds.
Real	job_time = 0.0
	Maximum wall-clock runtime in seconds.
int	natts_iter = 1
	Nonlinear iterative-coupling passes per step.
int	navg_max = 32
	Maximum gyroaveraging points per marker.
bool	nl_asym_equil = false
	Enable an up-down asymmetric equilibrium.
bool	nl_beta = false
	Use finite-beta electromagnetic normalization.
bool	nl_dry_run = false
	Stop after input parsing and validation.
bool	nl_electron_positron_plasma = false
	Use electron-positron species conventions.
bool	nl_freeze = false
	Freeze marker evolution for diagnostic runs.
bool	nl_i_accept_the_risks = false
	Opt in to guarded experimental combinations.
bool	nl_island = false
	Enable the prescribed magnetic-island model.
bool	nl_linear = false
	Use the linearized gyrokinetic model.
bool	nl_load_fields = false
	Initialize fields from saved data.
bool	nl_read_hdf5_checkpoint = false
	Restore an HDF5 checkpoint.
bool	nl_read_nTequil = false
	Read density-temperature equilibrium profiles.
bool	nl_read_write_checkpoint_and_exit = false
	Rewrite a checkpoint and exit.
bool	nl_res = false
	Resume from legacy restart state.
bool	nl_save = false
	Write legacy restart state.
bool	nl_save_fields = false
	Save field state for reuse.
bool	nl_test_ami = false
	Enable the Ampere matrix-inversion test path.
bool	nl_verbose = false
	Emit verbose parameter and progress output.
bool	nl_write_hdf5_checkpoint = false
	Write an HDF5 checkpoint.
int	nrun = 0
	Maximum number of time steps.
int	nsel_electron_values = 0
	Policy for inferred electron parameters.
int	nsel_equil = 0
	Magnetic-equilibrium selector; see NSelEquil.
int	nsel_ion_values = 0
	Policy for inferred main-ion parameters.
int	nsel_normalize_density = 0
	Density-normalization selector.
int	nsel_quasineutral = 0
	Quasineutrality-model selector.
int	nsel_time_integrator = 0
	Time-integration selector; see NSelTimeIntegrator.
int	nspecies = 0
	Number of configured species.
Real	nTequil_flat = 0.85
	Radius beyond which equilibrium gradients are flattened.
Real	physics_time_limit = -1.0
	Maximum normalized physics time; negative disables it.
std::string	record_path = "./dat"
	Restart/checkpoint record directory.
Real	rfsavetime = 0.0
	Wall-clock interval between restart saves, in seconds.
Real	s_push = 0.1
	Radius below which the axis-safe marker push is selected.

Detailed Description

Top-level run control shared by initialization and the time loop.

Physical time is normalized to the reference ion cyclotron time; explicitly wall-clock quantities are expressed in seconds.

Member Data Documentation

◆ dt

Real orb5x::BasicVariables::dt = 0.0

Simulation step in normalized time units.

◆ extra_time

Real orb5x::BasicVariables::extra_time = 0.0

Wall-clock reserve for output and shutdown, in seconds.

◆ job_time

Real orb5x::BasicVariables::job_time = 0.0

Maximum wall-clock runtime in seconds.

◆ natts_iter

int orb5x::BasicVariables::natts_iter = 1

Nonlinear iterative-coupling passes per step.

◆ navg_max

int orb5x::BasicVariables::navg_max = 32

Maximum gyroaveraging points per marker.

◆ nl_asym_equil

bool orb5x::BasicVariables::nl_asym_equil = false

Enable an up-down asymmetric equilibrium.

◆ nl_beta

bool orb5x::BasicVariables::nl_beta = false

Use finite-beta electromagnetic normalization.

◆ nl_dry_run

bool orb5x::BasicVariables::nl_dry_run = false

Stop after input parsing and validation.

◆ nl_electron_positron_plasma

bool orb5x::BasicVariables::nl_electron_positron_plasma = false

Use electron-positron species conventions.

◆ nl_freeze

bool orb5x::BasicVariables::nl_freeze = false

Freeze marker evolution for diagnostic runs.

◆ nl_i_accept_the_risks

bool orb5x::BasicVariables::nl_i_accept_the_risks = false

Opt in to guarded experimental combinations.

◆ nl_island

bool orb5x::BasicVariables::nl_island = false

Enable the prescribed magnetic-island model.

◆ nl_linear

bool orb5x::BasicVariables::nl_linear = false

Use the linearized gyrokinetic model.

◆ nl_load_fields

bool orb5x::BasicVariables::nl_load_fields = false

Initialize fields from saved data.

◆ nl_read_hdf5_checkpoint

bool orb5x::BasicVariables::nl_read_hdf5_checkpoint = false

Restore an HDF5 checkpoint.

◆ nl_read_nTequil

bool orb5x::BasicVariables::nl_read_nTequil = false

Read density-temperature equilibrium profiles.

◆ nl_read_write_checkpoint_and_exit

bool orb5x::BasicVariables::nl_read_write_checkpoint_and_exit = false

Rewrite a checkpoint and exit.

◆ nl_res

bool orb5x::BasicVariables::nl_res = false

Resume from legacy restart state.

◆ nl_save

bool orb5x::BasicVariables::nl_save = false

Write legacy restart state.

◆ nl_save_fields

bool orb5x::BasicVariables::nl_save_fields = false

Save field state for reuse.

◆ nl_test_ami

bool orb5x::BasicVariables::nl_test_ami = false

Enable the Ampere matrix-inversion test path.

◆ nl_verbose

bool orb5x::BasicVariables::nl_verbose = false

Emit verbose parameter and progress output.

◆ nl_write_hdf5_checkpoint

bool orb5x::BasicVariables::nl_write_hdf5_checkpoint = false

Write an HDF5 checkpoint.

◆ nrun

int orb5x::BasicVariables::nrun = 0

Maximum number of time steps.

◆ nsel_electron_values

int orb5x::BasicVariables::nsel_electron_values = 0

Policy for inferred electron parameters.

◆ nsel_equil

int orb5x::BasicVariables::nsel_equil = 0

Magnetic-equilibrium selector; see NSelEquil.

◆ nsel_ion_values

int orb5x::BasicVariables::nsel_ion_values = 0

Policy for inferred main-ion parameters.

◆ nsel_normalize_density

int orb5x::BasicVariables::nsel_normalize_density = 0

Density-normalization selector.

◆ nsel_quasineutral

int orb5x::BasicVariables::nsel_quasineutral = 0

Quasineutrality-model selector.

◆ nsel_time_integrator

int orb5x::BasicVariables::nsel_time_integrator = 0

Time-integration selector; see NSelTimeIntegrator.

◆ nspecies

int orb5x::BasicVariables::nspecies = 0

Number of configured species.

◆ nTequil_flat

Real orb5x::BasicVariables::nTequil_flat = 0.85

Radius beyond which equilibrium gradients are flattened.

◆ physics_time_limit

Real orb5x::BasicVariables::physics_time_limit = -1.0

Maximum normalized physics time; negative disables it.

◆ record_path

std::string orb5x::BasicVariables::record_path = "./dat"

Restart/checkpoint record directory.

◆ rfsavetime

Real orb5x::BasicVariables::rfsavetime = 0.0

Wall-clock interval between restart saves, in seconds.

◆ s_push

Real orb5x::BasicVariables::s_push = 0.1

Radius below which the axis-safe marker push is selected.

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

globals.hpp

Public Attributes