Complete physical, loading, source, and push state for one species. More...

#include "globals.hpp"

Collaboration diagram for orb5x::SpeciesVariables:

Public Member Functions
	SpeciesVariables ()
	Allocate fixed species input arrays and initialize sentinel bounds.

Public Attributes
Real	atomic_mass_number = 1.0
	Atomic mass number used by physical normalization.

Real	beam_freq = 8.27e10
	ECRH beam frequency in hertz.

int	beam_harmonic = 2
	Cyclotron harmonic used for electron resonance.

Real	beam_power_in = 0.0
	ECRH power entering the plasma in watts.

Real	beam_theta0 = 1.5708
	Mean ECRH beam angle in radians.

Real	beam_width = 0.0188
	ECRH beam width in metres.

Real	beta_speak = 1.0
	Normalized beta profile value at `speak`.

Real	buffer_edge = 0.9
	Inner radius of the outer buffer.

int	buffer_Nbin = 20
	Spatial bins used by the conservative Krook buffer.

Real	buffer_rate = 0.0
	Outer-buffer relaxation/collision rate.

BumpontailFeq	bumpontail
	Bump-on-tail distribution parameters.

CdtFeq	cdt
	CDT equilibrium-distribution parameters.

Real	charge = 1.0
	Species charge in elementary-charge units.

int	coarsen_nsteps = 10
	Steps between coarse-graining operations.

Real	cutoffvpa = 100.0
	Electron parallel-push cutoff relative to local thermal speed.

Real	deltarho = 0.4
	Half-width of the type-4 profile window.

Real	ds0_l = 0.2
	Width of the Gaussian spatial loading PDF.

NumericalF0	dump_f0
	Numerical `f0` grid prepared for output.

Real	electron_mass_ratio = -1.0
	Simulated-to-physical electron mass multiplier.

Real	f_part = 1.0
	Species dilution/fraction factor.

Real	fgau = 0.0
	Gaussian fraction of the mixed loading PDF.

Real	flow_force_rate = 0.0
	Relaxation rate of the imposed flow source.

Real	heat_edge_lim = 1.0
	Radius beyond which the heat source is zero.

Real	heatdep_sigma = 0.4
	Centre radius of the fixed heat source.

Real	heatdep_width = 0.1
	Radial width of the fixed heat source.

int	heating_nbins_en = 64
	Energy bins used by heating/source correction.

int	heating_nbins_r = 64
	Radial bins used by heating/source correction.

std::string	heatsource_file = "heatsource_profile"
	Radial heat-source profile path.

Real	i_addp = 0.0
	Cached zero/one multiplier for pressure terms.

Real	i_addp2 = 0.0
	Cached zero/one multiplier for the compensating pressure term.

Real	i_addvpa = 0.0
	Cached multiplier for the second-order `dv_parallel/dt` term.

Real	i_bgpot = 0.0
	Cached multiplier for background potential in `f0`.

Real	i_bst_str = 0.0
	Cached multiplier for the strong-flow `B*` term.

Real	i_cantormom = 0.0
	One selects canonical momentum; zero selects flux for `psi0`.

int	i_do_push = 0
	One evolves marker trajectories/weights; zero suppresses both.

Real	i_mir = 0.0
	Cached zero/one multiplier for the mirror force.

int	i_nonlinear = 0
	Cached multiplier: one for nonlinear dynamics, zero for linear.

Real	i_partl = 0.0
	Cached zero/one multiplier for parallel-velocity nonlinearity.

int	i_push_unperturbed_only = 0
	One restricts the trajectory to unperturbed fields.

Real	i_strfl = 0.0
	Cached multiplier for strong-flow dynamics.

Real	i_vpaback = 0.0
	Cached multiplier for the standard background-ExB term.

Real	i_vpaback_mod = 0.0
	Cached multiplier for the modified background-ExB term.

InitializeWeights	init_potential
	Initial-potential spectral envelope.

bool	is_electrons = false
	Species uses electron sign/mass/loading conventions.

bool	is_kinetic = false
	Species is represented by markers rather than a closure.

int	isort = 0
	Steps elapsed since the last cache sort.

Real	kappan0 = 0.0
	Peak normalized logarithmic density gradient.

Real	kappat0 = 2.4
	Peak normalized logarithmic temperature gradient.

Real	kappavp0 = 0.0
	Peak normalized parallel-flow gradient.

Real	kapv = 5.0
	Velocity-loading cutoff in thermal-speed units.

Real	kr_pert = 1.0
	Radial perturbation wavenumber in inverse minor radii.

Real	mass = 1.0
	Species mass divided by the first-species mass.

Real	midms = 0.0
	Reference-ion/species mass ratio, `1/mass`.

int	mmax_ini = 0
	Maximum poloidal mode of the initial `delta f` perturbation.

int	mmin_ini = 0
	Minimum poloidal mode of the initial `delta f` perturbation.

InitializeGene	mode_gene
	GENE-compatible perturbation parameters.

InitializeLigka	mode_ligka
	LIGKA perturbation parameters.

InitializeSaw	mode_saw
	SAW perturbation parameters.

Kokkos::View< Real[4]>	mode_saw_s_array
	Input mirror of the four SAW support radii.

Real	msdqs = 0.0
	Normalized species mass-to-charge ratio, `mass/charge`.

Real	msubq = 0.0
	Compatibility alias of `msdqs`.

Real	mu_N = 0.0
	Pedestal normalized density slope `(dN/drho)/N1`.

Real	mu_T = 0.0
	Pedestal normalized temperature slope `(dT/drho)/T1`.

Real	mu_VP = 0.0
	Pedestal normalized flow slope `(dVP/drho)/VP1`.

Real	mumax_input = 10.0
	Upper normalized magnetic-moment loading bound.

Real	n = 1.0e19
	Volume-averaged physical density in `m^-3`.

Real	N0 = 20.0
	Core maximum density for type-9/10 profiles.

Real	N1 = 1.0
	Density at `rhov_edge` for type-9/10 profiles.

Real	n_speak = 1.0
	Normalized density at `speak`.

std::string	name
	Human-readable species name used in input and output paths.

int	navg = 4
	Fixed gyro-point count or adaptive gyro-point scale factor.

int	nbins_en = 64
	Energy bins for phase-space coarse graining.

int	nbins_lambda = 64
	Pitch-angle bins for phase-space coarse graining.

bool	nl_2weights = false
	Use the two-weight marker formulation.

bool	nl_addp = true
	Include pressure terms in marker equations.

bool	nl_addp2 = false
	Include the pressure term compensating missing `B_parallel` drive.

bool	nl_addvpa = true
	Include the second-order magnetic term in `dv_parallel/dt`.

bool	nl_adiabatic_density = false
	Integrate adiabatic electron density with splines.

bool	nl_BCout_zero_weight = true
	Zero weight when a marker crosses the outer boundary.

bool	nl_bgpot = false
	Include the background potential in `f0`.

bool	nl_bst_str = false
	Include the strong-flow contribution to `B*`.

bool	nl_chargecorr = false
	Apply charge-conservation correction after deposition.

bool	nl_coarsen_pvol = true
	Coarsen marker phase-space volumes with weights.

bool	nl_dens_corr = false
	Apply marker density correction.

bool	nl_depos = false
	Deposit this species through `part_grid` when true.

bool	nl_df0_dt = false
	Include the equilibrium-flux time derivative in weight evolution.

bool	nl_directdf = false
	Evolve weights with the direct-`delta f` formulation.

bool	nl_dump_derivs = false
	Write derivatives of the equilibrium distribution.

bool	nl_dump_f0 = false
	Write the equilibrium distribution table.

bool	nl_f0can = true
	Use a canonical rather than local Maxwellian.

bool	nl_fixed_heat_source = false
	Enable the time-independent heat source.

bool	nl_mirror = true
	Include the magnetic-mirror force in `dv_parallel/dt`.

bool	nl_modified_can_mom = false
	Use the modified corrected canonical momentum.

bool	nl_no_vpar_nl = false
	Remove parallel-velocity nonlinearity.

bool	nl_num_f0_divide_n = true
	Divide numerical `f0` by equilibrium density.

bool	nl_psi0corr = false
	Correct the canonical-Maxwellian flux coordinate.

bool	nl_pure_toroidal_rotation = false
	Initialize neoclassical pure toroidal rotation.

bool	nl_randomload = false
	Use pseudorandom instead of low-discrepancy velocity loading.

bool	nl_strong = false
	Use strong-flow terms for this species.

bool	nl_vpaback = false
	Include the standard background-ExB parallel term.

bool	nl_vpaback_mod = false
	Include the modified background-ExB parallel term.

bool	nl_wclean = false
	Periodically clean weights for Alfven tests.

bool	nl_wclean_t0 = false
	Clean weights once at initial time.

bool	nl_wdecay_conserve_density = false
	Correct sources to conserve particle density.

bool	nl_wdecay_conserve_energy = false
	Correct sources to conserve kinetic energy.

bool	nl_wdecay_conserve_vpll = false
	Correct sources to conserve parallel momentum.

bool	nl_wdecay_conserve_zonal = false
	Project zonal-flow components out of Krook decay.

bool	nl_wdecay_gyro_switch = false
	Use the GYRO-compatible source formulation.

int	nmax_ini = 0
	Maximum toroidal mode of the initial `delta f` perturbation.

int	nmin_ini = 0
	Minimum toroidal mode of the initial `delta f` perturbation.

Int8	nptot = 2048
	Global marker count for this species.

Real	nref = 0.0
	Physical density at the normalization surface, `m^-3`.

int	nsel_adiabatic_gyr = 2
	Gyroaveraging strategy for adiabatic-density integration.

int	nsel_beam_type = 0
	ECRH X-mode/O-mode selector.

int	nsel_buffer_type = 0
	Outer buffer operator selector.

int	nsel_f0 = 0
	Equilibrium distribution selector; see NSelF0.

int	nsel_fixed_source_type = 0
	Fixed source model selector.

int	nsel_g_bref = 0
	Reference-field choice (`B0`, minimum, or maximum).

int	nsel_gyr = 0
	Marker gyroaveraging strategy; see NSelGyr.

int	nsel_heatsource_radial = 0
	Analytic-versus-file heat-source profile selector.

int	nsel_hybrid_model = 0
	Trapped/passing hybrid model selector.

int	nsel_init_pert = 0
	Initial perturbation selector; see NSelInitPert.

int	nsel_load_space = 0
	Electron configuration-space loading selector.

int	nsel_load_v = 0
	Velocity-space marker-loading PDF selector.

int	nsel_loadphi = 0
	Toroidal marker-loading sequence selector.

int	nsel_profile = 0
	Equilibrium profile family; see NSelProfile.

int	nsel_push = 0
	Marker trajectory/weight evolution selector; see NSelPush.

int	nsel_sort_cache = 1
	Guiding-centre cache-sorting selector.

int	nsel_testpart = 0
	Test-particle initialization/output selector.

int	nsel_tilt = 0
	Gyroangle-tilt selector; see NSelTilt.

int	nsel_vpar_constant_in_f0 = 2
	Prescription for the constant of motion in `df0/dt`.

NumericalF0	num_f0
	Numerical `f0` loaded for marker evaluation.

int	part_output_num = 0
	Maximum markers written to marker-level output.

Real	pdecay_coarsefac = 0.0
	Per-step coarse-graining factor for the second weight.

Real	pertw = 1.0e-3
	Initial `delta f` marker-weight perturbation.

Real	pitch_fac = 1.0
	Factor restricting loaded electron pitch away from loss boundaries.

Kokkos::View< Real[3]>	pszs_lb_array
	Lower bounds of the three PSZS coordinates.

Kokkos::View< Real[3]>	pszs_ub_array
	Upper bounds of the three PSZS coordinates.

Real	qs2dms = 0.0
	Normalized squared-charge-to-mass ratio, `charge*qsdms`.

Real	qsdms = 0.0
	Normalized charge-to-mass ratio, `charge/mass`.

QuadtreeSmooth	quadtree_par
	Quadtree smoothing controls.

bool	quadtree_par_seq_clones = false
	Legacy mirror of sequential-clone quadtree policy.

int	randomize_seed = 64
	Seed for toroidal scatter and noise rescaling.

Real	rho_plateau_mid = 0.5
	Centre of the type-4 profile plateau.

Real	rhov_core = 0.3
	Core exponential/parabolic transition in volume radius.

Real	rhov_edge = 1.0
	Pedestal-foot/SOL transition in volume radius.

Real	rhov_ped = 0.8
	Pedestal-top position in volume radius.

Real	s0_l = 0.5
	Centre of the Gaussian spatial loading PDF.

SlowingdownFeq	slowingdown
	Slowing-down distribution parameters.

int	sort_freq = 1
	Steps between guiding-centre cache sorts.

Real	speak = 0.5
	Radius of the maximum profile gradient.

Real	T0 = 20.0
	Core maximum temperature for type-9/10 profiles.

Real	T1 = 1.0
	Temperature at `rhov_edge` for type-9/10 profiles.

Real	T_speak = 1.0
	Normalized temperature at `speak`.

Real	tau = 1.0
	Species temperature divided by electron temperature at `speak`.

Real	true_electron_mass = -1.0
	Physical electron/reference-ion mass ratio.

Real	umax_input = 1.0
	Upper normalized parallel/speed loading bound.

Real	umin_input = -1.0
	Lower normalized parallel/speed loading bound.

Real	v_avg_dens = 0.0
	Volume-averaged normalized density used for beta.

Real	VP0 = 20.0
	Core maximum parallel flow for type-9/10 profiles.

Real	VP1 = 1.0
	Parallel flow at `rhov_edge` for type-9/10 profiles.

Real	vpar = 0.0
	Equilibrium parallel flow at `speak`, normalized velocity.

Real	wdecay_coarsefac = 0.0
	Per-step coarse-graining factor for the first weight.

Real	wdecay_edgefac = 0.0
	Additional weight-decay rate outside `wdecay_sedge`.

Real	wdecay_ediffrate = 0.0
	Normalized marker energy-diffusion rate.

Real	wdecay_heat_s0 = 0.5
	Right edge of the core-heating interval.

Real	wdecay_heat_s1 = 0.5
	Left edge of the edge-cooling interval.

Real	wdecay_heatrate = 0.0
	Decay rate of radially smoothed `delta f(E,s)`.

Real	wdecay_psourcerate = 0.0
	Particle-source relaxation rate.

Real	wdecay_rate = 0.0
	Krook marker-weight decay rate.

Real	wdecay_sedge = 1.0
	Inner edge of outer weight decay.

Real	widths = 0.208
	Radial width of density and temperature gradients.

Detailed Description

Complete physical, loading, source, and push state for one species.

One instance exists for every kinetic or adiabatic species. ReadInput fills dimensional inputs, normalization derives the cached ratios, ParticleModule owns markers governed by these choices, and fields/diagnostics consume the same state. Unless stated otherwise, radii are normalized s, velocities are normalized to the reference thermal speed, and rates use normalized inverse time.

Constructor & Destructor Documentation

◆ SpeciesVariables()

orb5x::SpeciesVariables::SpeciesVariables ( )

inline

Allocate fixed species input arrays and initialize sentinel bounds.

Precondition: Kokkos is initialized.

References mode_saw_s_array, pszs_lb_array, and pszs_ub_array.

Member Data Documentation

◆ atomic_mass_number

Real orb5x::SpeciesVariables::atomic_mass_number = 1.0

Atomic mass number used by physical normalization.

◆ beam_freq

Real orb5x::SpeciesVariables::beam_freq = 8.27e10

ECRH beam frequency in hertz.

◆ beam_harmonic

int orb5x::SpeciesVariables::beam_harmonic = 2

Cyclotron harmonic used for electron resonance.

◆ beam_power_in

Real orb5x::SpeciesVariables::beam_power_in = 0.0

ECRH power entering the plasma in watts.

◆ beam_theta0

Real orb5x::SpeciesVariables::beam_theta0 = 1.5708

Mean ECRH beam angle in radians.

◆ beam_width

Real orb5x::SpeciesVariables::beam_width = 0.0188

ECRH beam width in metres.

◆ beta_speak

Real orb5x::SpeciesVariables::beta_speak = 1.0

Normalized beta profile value at speak.

◆ buffer_edge

Real orb5x::SpeciesVariables::buffer_edge = 0.9

Inner radius of the outer buffer.

◆ buffer_Nbin

int orb5x::SpeciesVariables::buffer_Nbin = 20

Spatial bins used by the conservative Krook buffer.

◆ buffer_rate

Real orb5x::SpeciesVariables::buffer_rate = 0.0

Outer-buffer relaxation/collision rate.

◆ bumpontail

BumpontailFeq orb5x::SpeciesVariables::bumpontail

Bump-on-tail distribution parameters.

◆ cdt

CdtFeq orb5x::SpeciesVariables::cdt

CDT equilibrium-distribution parameters.

◆ charge

Real orb5x::SpeciesVariables::charge = 1.0

Species charge in elementary-charge units.

◆ coarsen_nsteps

int orb5x::SpeciesVariables::coarsen_nsteps = 10

Steps between coarse-graining operations.

◆ cutoffvpa

Real orb5x::SpeciesVariables::cutoffvpa = 100.0

Electron parallel-push cutoff relative to local thermal speed.

◆ deltarho

Real orb5x::SpeciesVariables::deltarho = 0.4

Half-width of the type-4 profile window.

◆ ds0_l

Real orb5x::SpeciesVariables::ds0_l = 0.2

Width of the Gaussian spatial loading PDF.

◆ dump_f0

NumericalF0 orb5x::SpeciesVariables::dump_f0

Numerical f0 grid prepared for output.

◆ electron_mass_ratio

Real orb5x::SpeciesVariables::electron_mass_ratio = -1.0

Simulated-to-physical electron mass multiplier.

◆ f_part

Real orb5x::SpeciesVariables::f_part = 1.0

Species dilution/fraction factor.

◆ fgau

Real orb5x::SpeciesVariables::fgau = 0.0

Gaussian fraction of the mixed loading PDF.

◆ flow_force_rate

Real orb5x::SpeciesVariables::flow_force_rate = 0.0

Relaxation rate of the imposed flow source.

◆ heat_edge_lim

Real orb5x::SpeciesVariables::heat_edge_lim = 1.0

Radius beyond which the heat source is zero.

◆ heatdep_sigma

Real orb5x::SpeciesVariables::heatdep_sigma = 0.4

Centre radius of the fixed heat source.

◆ heatdep_width

Real orb5x::SpeciesVariables::heatdep_width = 0.1

Radial width of the fixed heat source.

◆ heating_nbins_en

int orb5x::SpeciesVariables::heating_nbins_en = 64

Energy bins used by heating/source correction.

◆ heating_nbins_r

int orb5x::SpeciesVariables::heating_nbins_r = 64

Radial bins used by heating/source correction.

◆ heatsource_file

std::string orb5x::SpeciesVariables::heatsource_file = "heatsource_profile"

Radial heat-source profile path.

◆ i_addp

Real orb5x::SpeciesVariables::i_addp = 0.0

Cached zero/one multiplier for pressure terms.

◆ i_addp2

Real orb5x::SpeciesVariables::i_addp2 = 0.0

Cached zero/one multiplier for the compensating pressure term.

◆ i_addvpa

Real orb5x::SpeciesVariables::i_addvpa = 0.0

Cached multiplier for the second-order dv_parallel/dt term.

◆ i_bgpot

Real orb5x::SpeciesVariables::i_bgpot = 0.0

Cached multiplier for background potential in f0.

◆ i_bst_str

Real orb5x::SpeciesVariables::i_bst_str = 0.0

Cached multiplier for the strong-flow B* term.

◆ i_cantormom

Real orb5x::SpeciesVariables::i_cantormom = 0.0

One selects canonical momentum; zero selects flux for psi0.

◆ i_do_push

int orb5x::SpeciesVariables::i_do_push = 0

One evolves marker trajectories/weights; zero suppresses both.

◆ i_mir

Real orb5x::SpeciesVariables::i_mir = 0.0

Cached zero/one multiplier for the mirror force.

◆ i_nonlinear

int orb5x::SpeciesVariables::i_nonlinear = 0

Cached multiplier: one for nonlinear dynamics, zero for linear.

◆ i_partl

Real orb5x::SpeciesVariables::i_partl = 0.0

Cached zero/one multiplier for parallel-velocity nonlinearity.

◆ i_push_unperturbed_only

int orb5x::SpeciesVariables::i_push_unperturbed_only = 0

One restricts the trajectory to unperturbed fields.

◆ i_strfl

Real orb5x::SpeciesVariables::i_strfl = 0.0

Cached multiplier for strong-flow dynamics.

◆ i_vpaback

Real orb5x::SpeciesVariables::i_vpaback = 0.0

Cached multiplier for the standard background-ExB term.

◆ i_vpaback_mod

Real orb5x::SpeciesVariables::i_vpaback_mod = 0.0

Cached multiplier for the modified background-ExB term.

◆ init_potential

InitializeWeights orb5x::SpeciesVariables::init_potential

Initial-potential spectral envelope.

◆ is_electrons

bool orb5x::SpeciesVariables::is_electrons = false

Species uses electron sign/mass/loading conventions.

◆ is_kinetic

bool orb5x::SpeciesVariables::is_kinetic = false

Species is represented by markers rather than a closure.

◆ isort

int orb5x::SpeciesVariables::isort = 0

Steps elapsed since the last cache sort.

◆ kappan0

Real orb5x::SpeciesVariables::kappan0 = 0.0

Peak normalized logarithmic density gradient.

◆ kappat0

Real orb5x::SpeciesVariables::kappat0 = 2.4

Peak normalized logarithmic temperature gradient.

◆ kappavp0

Real orb5x::SpeciesVariables::kappavp0 = 0.0

Peak normalized parallel-flow gradient.

◆ kapv

Real orb5x::SpeciesVariables::kapv = 5.0

Velocity-loading cutoff in thermal-speed units.

◆ kr_pert

Real orb5x::SpeciesVariables::kr_pert = 1.0

Radial perturbation wavenumber in inverse minor radii.

◆ mass

Real orb5x::SpeciesVariables::mass = 1.0

Species mass divided by the first-species mass.

◆ midms

Real orb5x::SpeciesVariables::midms = 0.0

Reference-ion/species mass ratio, 1/mass.

◆ mmax_ini

int orb5x::SpeciesVariables::mmax_ini = 0

Maximum poloidal mode of the initial delta f perturbation.

◆ mmin_ini

int orb5x::SpeciesVariables::mmin_ini = 0

Minimum poloidal mode of the initial delta f perturbation.

◆ mode_gene

InitializeGene orb5x::SpeciesVariables::mode_gene

GENE-compatible perturbation parameters.

◆ mode_ligka

InitializeLigka orb5x::SpeciesVariables::mode_ligka

LIGKA perturbation parameters.

◆ mode_saw

InitializeSaw orb5x::SpeciesVariables::mode_saw

SAW perturbation parameters.

◆ mode_saw_s_array

Kokkos::View<Real[4]> orb5x::SpeciesVariables::mode_saw_s_array

Input mirror of the four SAW support radii.

Referenced by SpeciesVariables().

◆ msdqs

Real orb5x::SpeciesVariables::msdqs = 0.0

Normalized species mass-to-charge ratio, mass/charge.

◆ msubq

Real orb5x::SpeciesVariables::msubq = 0.0

Compatibility alias of msdqs.

◆ mu_N

Real orb5x::SpeciesVariables::mu_N = 0.0

Pedestal normalized density slope (dN/drho)/N1.

◆ mu_T

Real orb5x::SpeciesVariables::mu_T = 0.0

Pedestal normalized temperature slope (dT/drho)/T1.

◆ mu_VP

Real orb5x::SpeciesVariables::mu_VP = 0.0

Pedestal normalized flow slope (dVP/drho)/VP1.

◆ mumax_input

Real orb5x::SpeciesVariables::mumax_input = 10.0

Upper normalized magnetic-moment loading bound.

◆ n

Real orb5x::SpeciesVariables::n = 1.0e19

Volume-averaged physical density in m^-3.

◆ N0

Real orb5x::SpeciesVariables::N0 = 20.0

Core maximum density for type-9/10 profiles.

◆ N1

Real orb5x::SpeciesVariables::N1 = 1.0

Density at rhov_edge for type-9/10 profiles.

◆ n_speak

Real orb5x::SpeciesVariables::n_speak = 1.0

Normalized density at speak.

◆ name

std::string orb5x::SpeciesVariables::name

Human-readable species name used in input and output paths.

◆ navg

int orb5x::SpeciesVariables::navg = 4

Fixed gyro-point count or adaptive gyro-point scale factor.

◆ nbins_en

int orb5x::SpeciesVariables::nbins_en = 64

Energy bins for phase-space coarse graining.

◆ nbins_lambda

int orb5x::SpeciesVariables::nbins_lambda = 64

Pitch-angle bins for phase-space coarse graining.

◆ nl_2weights

bool orb5x::SpeciesVariables::nl_2weights = false

Use the two-weight marker formulation.

◆ nl_addp

bool orb5x::SpeciesVariables::nl_addp = true

Include pressure terms in marker equations.

◆ nl_addp2

bool orb5x::SpeciesVariables::nl_addp2 = false

Include the pressure term compensating missing B_parallel drive.

◆ nl_addvpa

bool orb5x::SpeciesVariables::nl_addvpa = true

Include the second-order magnetic term in dv_parallel/dt.

◆ nl_adiabatic_density

bool orb5x::SpeciesVariables::nl_adiabatic_density = false

Integrate adiabatic electron density with splines.

◆ nl_BCout_zero_weight

bool orb5x::SpeciesVariables::nl_BCout_zero_weight = true

Zero weight when a marker crosses the outer boundary.

◆ nl_bgpot

bool orb5x::SpeciesVariables::nl_bgpot = false

Include the background potential in f0.

◆ nl_bst_str

bool orb5x::SpeciesVariables::nl_bst_str = false

Include the strong-flow contribution to B*.

◆ nl_chargecorr

bool orb5x::SpeciesVariables::nl_chargecorr = false

Apply charge-conservation correction after deposition.

◆ nl_coarsen_pvol

bool orb5x::SpeciesVariables::nl_coarsen_pvol = true

Coarsen marker phase-space volumes with weights.

◆ nl_dens_corr

bool orb5x::SpeciesVariables::nl_dens_corr = false

Apply marker density correction.

◆ nl_depos

bool orb5x::SpeciesVariables::nl_depos = false

Deposit this species through part_grid when true.

◆ nl_df0_dt

bool orb5x::SpeciesVariables::nl_df0_dt = false

Include the equilibrium-flux time derivative in weight evolution.

◆ nl_directdf

bool orb5x::SpeciesVariables::nl_directdf = false

Evolve weights with the direct-delta f formulation.

◆ nl_dump_derivs

bool orb5x::SpeciesVariables::nl_dump_derivs = false

Write derivatives of the equilibrium distribution.

◆ nl_dump_f0

bool orb5x::SpeciesVariables::nl_dump_f0 = false

Write the equilibrium distribution table.

◆ nl_f0can

bool orb5x::SpeciesVariables::nl_f0can = true

Use a canonical rather than local Maxwellian.

◆ nl_fixed_heat_source

bool orb5x::SpeciesVariables::nl_fixed_heat_source = false

Enable the time-independent heat source.

◆ nl_mirror

bool orb5x::SpeciesVariables::nl_mirror = true

Include the magnetic-mirror force in dv_parallel/dt.

◆ nl_modified_can_mom

bool orb5x::SpeciesVariables::nl_modified_can_mom = false

Use the modified corrected canonical momentum.

◆ nl_no_vpar_nl

bool orb5x::SpeciesVariables::nl_no_vpar_nl = false

Remove parallel-velocity nonlinearity.

◆ nl_num_f0_divide_n

bool orb5x::SpeciesVariables::nl_num_f0_divide_n = true

Divide numerical f0 by equilibrium density.

◆ nl_psi0corr

bool orb5x::SpeciesVariables::nl_psi0corr = false

Correct the canonical-Maxwellian flux coordinate.

◆ nl_pure_toroidal_rotation

bool orb5x::SpeciesVariables::nl_pure_toroidal_rotation = false

Initialize neoclassical pure toroidal rotation.

◆ nl_randomload

bool orb5x::SpeciesVariables::nl_randomload = false

Use pseudorandom instead of low-discrepancy velocity loading.

◆ nl_strong

bool orb5x::SpeciesVariables::nl_strong = false

Use strong-flow terms for this species.

◆ nl_vpaback

bool orb5x::SpeciesVariables::nl_vpaback = false

Include the standard background-ExB parallel term.

◆ nl_vpaback_mod

bool orb5x::SpeciesVariables::nl_vpaback_mod = false

Include the modified background-ExB parallel term.

◆ nl_wclean

bool orb5x::SpeciesVariables::nl_wclean = false

Periodically clean weights for Alfven tests.

◆ nl_wclean_t0

bool orb5x::SpeciesVariables::nl_wclean_t0 = false

Clean weights once at initial time.

◆ nl_wdecay_conserve_density

bool orb5x::SpeciesVariables::nl_wdecay_conserve_density = false

Correct sources to conserve particle density.

◆ nl_wdecay_conserve_energy

bool orb5x::SpeciesVariables::nl_wdecay_conserve_energy = false

Correct sources to conserve kinetic energy.

◆ nl_wdecay_conserve_vpll

bool orb5x::SpeciesVariables::nl_wdecay_conserve_vpll = false

Correct sources to conserve parallel momentum.

◆ nl_wdecay_conserve_zonal

bool orb5x::SpeciesVariables::nl_wdecay_conserve_zonal = false

Project zonal-flow components out of Krook decay.

◆ nl_wdecay_gyro_switch

bool orb5x::SpeciesVariables::nl_wdecay_gyro_switch = false

Use the GYRO-compatible source formulation.

◆ nmax_ini

int orb5x::SpeciesVariables::nmax_ini = 0

Maximum toroidal mode of the initial delta f perturbation.

◆ nmin_ini

int orb5x::SpeciesVariables::nmin_ini = 0

Minimum toroidal mode of the initial delta f perturbation.

◆ nptot

Int8 orb5x::SpeciesVariables::nptot = 2048

Global marker count for this species.

◆ nref

Real orb5x::SpeciesVariables::nref = 0.0

Physical density at the normalization surface, m^-3.

◆ nsel_adiabatic_gyr

int orb5x::SpeciesVariables::nsel_adiabatic_gyr = 2

Gyroaveraging strategy for adiabatic-density integration.

◆ nsel_beam_type

int orb5x::SpeciesVariables::nsel_beam_type = 0

ECRH X-mode/O-mode selector.

◆ nsel_buffer_type

int orb5x::SpeciesVariables::nsel_buffer_type = 0

Outer buffer operator selector.

◆ nsel_f0

int orb5x::SpeciesVariables::nsel_f0 = 0

Equilibrium distribution selector; see NSelF0.

◆ nsel_fixed_source_type

int orb5x::SpeciesVariables::nsel_fixed_source_type = 0

Fixed source model selector.

◆ nsel_g_bref

int orb5x::SpeciesVariables::nsel_g_bref = 0

Reference-field choice (B0, minimum, or maximum).

◆ nsel_gyr

int orb5x::SpeciesVariables::nsel_gyr = 0

Marker gyroaveraging strategy; see NSelGyr.

◆ nsel_heatsource_radial

int orb5x::SpeciesVariables::nsel_heatsource_radial = 0

Analytic-versus-file heat-source profile selector.

◆ nsel_hybrid_model

int orb5x::SpeciesVariables::nsel_hybrid_model = 0

Trapped/passing hybrid model selector.

◆ nsel_init_pert

int orb5x::SpeciesVariables::nsel_init_pert = 0

Initial perturbation selector; see NSelInitPert.

◆ nsel_load_space

int orb5x::SpeciesVariables::nsel_load_space = 0

Electron configuration-space loading selector.

◆ nsel_load_v

int orb5x::SpeciesVariables::nsel_load_v = 0

Velocity-space marker-loading PDF selector.

◆ nsel_loadphi

int orb5x::SpeciesVariables::nsel_loadphi = 0

Toroidal marker-loading sequence selector.

◆ nsel_profile

int orb5x::SpeciesVariables::nsel_profile = 0

Equilibrium profile family; see NSelProfile.

◆ nsel_push

int orb5x::SpeciesVariables::nsel_push = 0

Marker trajectory/weight evolution selector; see NSelPush.

◆ nsel_sort_cache

int orb5x::SpeciesVariables::nsel_sort_cache = 1

Guiding-centre cache-sorting selector.

◆ nsel_testpart

int orb5x::SpeciesVariables::nsel_testpart = 0

Test-particle initialization/output selector.

◆ nsel_tilt

int orb5x::SpeciesVariables::nsel_tilt = 0

Gyroangle-tilt selector; see NSelTilt.

◆ nsel_vpar_constant_in_f0

int orb5x::SpeciesVariables::nsel_vpar_constant_in_f0 = 2

Prescription for the constant of motion in df0/dt.

◆ num_f0

NumericalF0 orb5x::SpeciesVariables::num_f0

Numerical f0 loaded for marker evaluation.

◆ part_output_num

int orb5x::SpeciesVariables::part_output_num = 0

Maximum markers written to marker-level output.

◆ pdecay_coarsefac

Real orb5x::SpeciesVariables::pdecay_coarsefac = 0.0

Per-step coarse-graining factor for the second weight.

◆ pertw

Real orb5x::SpeciesVariables::pertw = 1.0e-3

Initial delta f marker-weight perturbation.

◆ pitch_fac

Real orb5x::SpeciesVariables::pitch_fac = 1.0

Factor restricting loaded electron pitch away from loss boundaries.

◆ pszs_lb_array

Kokkos::View<Real[3]> orb5x::SpeciesVariables::pszs_lb_array

Lower bounds of the three PSZS coordinates.

Referenced by SpeciesVariables().

◆ pszs_ub_array

Kokkos::View<Real[3]> orb5x::SpeciesVariables::pszs_ub_array

Upper bounds of the three PSZS coordinates.

Referenced by SpeciesVariables().

◆ qs2dms

Real orb5x::SpeciesVariables::qs2dms = 0.0

Normalized squared-charge-to-mass ratio, charge*qsdms.

◆ qsdms

Real orb5x::SpeciesVariables::qsdms = 0.0

Normalized charge-to-mass ratio, charge/mass.

◆ quadtree_par

QuadtreeSmooth orb5x::SpeciesVariables::quadtree_par

Quadtree smoothing controls.

◆ quadtree_par_seq_clones

bool orb5x::SpeciesVariables::quadtree_par_seq_clones = false

Legacy mirror of sequential-clone quadtree policy.

◆ randomize_seed

int orb5x::SpeciesVariables::randomize_seed = 64

Seed for toroidal scatter and noise rescaling.

◆ rho_plateau_mid

Real orb5x::SpeciesVariables::rho_plateau_mid = 0.5

Centre of the type-4 profile plateau.

◆ rhov_core

Real orb5x::SpeciesVariables::rhov_core = 0.3

Core exponential/parabolic transition in volume radius.

◆ rhov_edge

Real orb5x::SpeciesVariables::rhov_edge = 1.0

Pedestal-foot/SOL transition in volume radius.

◆ rhov_ped

Real orb5x::SpeciesVariables::rhov_ped = 0.8

Pedestal-top position in volume radius.

◆ s0_l

Real orb5x::SpeciesVariables::s0_l = 0.5

Centre of the Gaussian spatial loading PDF.

◆ slowingdown

SlowingdownFeq orb5x::SpeciesVariables::slowingdown

Slowing-down distribution parameters.

◆ sort_freq

int orb5x::SpeciesVariables::sort_freq = 1

Steps between guiding-centre cache sorts.

◆ speak

Real orb5x::SpeciesVariables::speak = 0.5

Radius of the maximum profile gradient.

◆ T0

Real orb5x::SpeciesVariables::T0 = 20.0

Core maximum temperature for type-9/10 profiles.

◆ T1

Real orb5x::SpeciesVariables::T1 = 1.0

Temperature at rhov_edge for type-9/10 profiles.

◆ T_speak

Real orb5x::SpeciesVariables::T_speak = 1.0

Normalized temperature at speak.

◆ tau

Real orb5x::SpeciesVariables::tau = 1.0

Species temperature divided by electron temperature at speak.

◆ true_electron_mass

Real orb5x::SpeciesVariables::true_electron_mass = -1.0

Physical electron/reference-ion mass ratio.

◆ umax_input

Real orb5x::SpeciesVariables::umax_input = 1.0

Upper normalized parallel/speed loading bound.

◆ umin_input

Real orb5x::SpeciesVariables::umin_input = -1.0

Lower normalized parallel/speed loading bound.

◆ v_avg_dens

Real orb5x::SpeciesVariables::v_avg_dens = 0.0

Volume-averaged normalized density used for beta.

◆ VP0

Real orb5x::SpeciesVariables::VP0 = 20.0

Core maximum parallel flow for type-9/10 profiles.

◆ VP1

Real orb5x::SpeciesVariables::VP1 = 1.0

Parallel flow at rhov_edge for type-9/10 profiles.

◆ vpar

Real orb5x::SpeciesVariables::vpar = 0.0

Equilibrium parallel flow at speak, normalized velocity.

◆ wdecay_coarsefac

Real orb5x::SpeciesVariables::wdecay_coarsefac = 0.0

Per-step coarse-graining factor for the first weight.

◆ wdecay_edgefac

Real orb5x::SpeciesVariables::wdecay_edgefac = 0.0

Additional weight-decay rate outside wdecay_sedge.

◆ wdecay_ediffrate

Real orb5x::SpeciesVariables::wdecay_ediffrate = 0.0

Normalized marker energy-diffusion rate.

◆ wdecay_heat_s0

Real orb5x::SpeciesVariables::wdecay_heat_s0 = 0.5

Right edge of the core-heating interval.

◆ wdecay_heat_s1

Real orb5x::SpeciesVariables::wdecay_heat_s1 = 0.5

Left edge of the edge-cooling interval.

◆ wdecay_heatrate

Real orb5x::SpeciesVariables::wdecay_heatrate = 0.0

Decay rate of radially smoothed delta f(E,s).

◆ wdecay_psourcerate

Real orb5x::SpeciesVariables::wdecay_psourcerate = 0.0

Particle-source relaxation rate.

◆ wdecay_rate

Real orb5x::SpeciesVariables::wdecay_rate = 0.0

Krook marker-weight decay rate.

◆ wdecay_sedge

Real orb5x::SpeciesVariables::wdecay_sedge = 1.0

Inner edge of outer weight decay.

◆ widths

Real orb5x::SpeciesVariables::widths = 0.208

Radial width of density and temperature gradients.

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

globals.hpp

ORB5X 1.0.0 Performance-portable global electromagnetic gyrokinetic PIC code

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SpeciesVariables()

Member Data Documentation

◆ atomic_mass_number

◆ beam_freq

◆ beam_harmonic

◆ beam_power_in

◆ beam_theta0

◆ beam_width

◆ beta_speak

◆ buffer_edge

◆ buffer_Nbin

◆ buffer_rate

◆ bumpontail

◆ cdt

◆ charge

◆ coarsen_nsteps

◆ cutoffvpa

◆ deltarho

◆ ds0_l

◆ dump_f0

◆ electron_mass_ratio

◆ f_part

◆ fgau

◆ flow_force_rate

◆ heat_edge_lim

◆ heatdep_sigma

◆ heatdep_width

◆ heating_nbins_en

◆ heating_nbins_r

◆ heatsource_file

◆ i_addp

◆ i_addp2

◆ i_addvpa

◆ i_bgpot

◆ i_bst_str

◆ i_cantormom

◆ i_do_push

◆ i_mir

◆ i_nonlinear

◆ i_partl

◆ i_push_unperturbed_only

◆ i_strfl

◆ i_vpaback

◆ i_vpaback_mod

◆ init_potential

◆ is_electrons

◆ is_kinetic

◆ isort

◆ kappan0

◆ kappat0

◆ kappavp0

◆ kapv

◆ kr_pert

◆ mass

◆ midms

◆ mmax_ini

◆ mmin_ini

◆ mode_gene

◆ mode_ligka

◆ mode_saw

◆ mode_saw_s_array

◆ msdqs

◆ msubq

◆ mu_N

◆ mu_T

◆ mu_VP

◆ mumax_input

◆ n

◆ N0

◆ N1

◆ n_speak

◆ name

◆ navg

◆ nbins_en

◆ nbins_lambda

◆ nl_2weights