orb5x::FieldsVariables Struct Reference

Field mesh, Fourier filtering, and background-electric-field state. More...

#include "globals.hpp"

Collaboration diagram for orb5x::FieldsVariables:

Public Member Functions
	FieldsVariables ()
	Allocate and zero the explicit toroidal-mode filter.

Public Attributes
int	background_diamag_comp = 0
	Background diamagnetic compensation selector.
Real	background_efield_const = 0.0
	Constant contribution to the background electric field.
Real	background_efield_deltarho = 0.0
	Radial width of the background-field transition.
Real	background_efield_size = 0.0
	Amplitude of the prescribed radial electric field.
Real	background_efield_sreverse = -1.0
	Flow-reversal radius; negative disables reversal.
int	deltam = 0
	Half-width of retained coupled poloidal modes.
FilterSaw	filt_saw
	Sawtooth-specific (n,m) mode restrictions.
int	filtdim = 2
	Number of angular dimensions to Fourier-filter.
bool	filter_noise = false
	Apply the selected noise filter after deposition.
Kokkos::View< int[20]>	filtvaln
	Explicit retained toroidal mode numbers.
Real	flow_scale = 1.0
	Multiplicative scale applied to equilibrium flow.
int	k_offset = 0
	Global toroidal-plane offset of this spatial rank.
Real	kthrhomax = 0.0
	Maximum retained perpendicular k_theta rho.
int	mfilt1 = -2000
	Minimum retained poloidal Fourier mode.
int	mfilt2 = 2000
	Maximum retained poloidal Fourier mode.
int	n_flux_tube = 0
	Number of toroidal flux-tube sectors.
int	nblocks = 1
	Number of radial blocks used by field operations.
int	nchi = 0
	Number of poloidal field intervals.
int	nchip = 0
	Poloidal grid size including the periodic endpoint.
int	nfilt1 = 0
	Minimum retained toroidal Fourier mode.
int	nfilt2 = 8
	Maximum retained toroidal Fourier mode.
int	nidbas = 0
	B-spline polynomial degree.
bool	nl_compute_fields = false
	Solve self-consistent fields during the time loop.
bool	nl_gradgyr = false
	Include gradients of gyroaveraged field quantities.
bool	nl_neoclassical = false
	Enable axisymmetric neoclassical field treatment.
int	nphi = 0
	Number of local toroidal field intervals.
int	nphip = 0
	Local toroidal grid size including the periodic endpoint.
int	ns = 0
	Number of radial field intervals.
int	nsel_dft_method = 0
	Discrete-Fourier-transform implementation selector.
int	nsel_filter = 1
	Fourier-filter selector; see NSelFilter.
int	nsel_fix_fields = 0
	Selector for externally fixed field components.
int	nsel_getfield = 0
	Marker field-interpolation selector.
int	nsel_inner_bc = 2
	Magnetic-axis boundary selector; see NSelInnerBC.
int	nsel_noise_filter = 0
	Noise-filter stencil selector.
int	nsel_pot_profile = 0
	Prescribed potential-profile selector.
int	nsel_setrho = 0
	Charge-density deposition selector.
int	nsel_strong = 0
	Strong-form/weak-form field-evaluation selector.
Real	sfmax = 0.0
	Upper normalized radial boundary of the field mesh.
Real	sfmin = 0.0
	Lower normalized radial boundary of the field mesh.
Real	sreverse_smooth = 0.01
	Smoothing width around the flow-reversal radius.
int	stride_refresh_larmor = 0
	Steps between gyroaveraging-table refreshes; zero uses policy default.

Detailed Description

Field mesh, Fourier filtering, and background-electric-field state.

Grid counts describe the tensor-product B-spline field representation; particle modules consume the derived periodic extents and mode filters.

Constructor & Destructor Documentation

FieldsVariables()

orb5x::FieldsVariables::FieldsVariables ( )

inline

Allocate and zero the explicit toroidal-mode filter.

Precondition

Kokkos is initialized.

References filtvaln.

Member Data Documentation

background_diamag_comp

int orb5x::FieldsVariables::background_diamag_comp = 0

Background diamagnetic compensation selector.

background_efield_const

Real orb5x::FieldsVariables::background_efield_const = 0.0

Constant contribution to the background electric field.

background_efield_deltarho

Real orb5x::FieldsVariables::background_efield_deltarho = 0.0

Radial width of the background-field transition.

background_efield_size

Real orb5x::FieldsVariables::background_efield_size = 0.0

Amplitude of the prescribed radial electric field.

background_efield_sreverse

Real orb5x::FieldsVariables::background_efield_sreverse = -1.0

Flow-reversal radius; negative disables reversal.

deltam

int orb5x::FieldsVariables::deltam = 0

Half-width of retained coupled poloidal modes.

filt_saw

FilterSaw orb5x::FieldsVariables::filt_saw

Sawtooth-specific (n,m) mode restrictions.

filtdim

int orb5x::FieldsVariables::filtdim = 2

Number of angular dimensions to Fourier-filter.

filter_noise

bool orb5x::FieldsVariables::filter_noise = false

Apply the selected noise filter after deposition.

filtvaln

Kokkos::View<int[20]> orb5x::FieldsVariables::filtvaln

Explicit retained toroidal mode numbers.

Referenced by FieldsVariables().

flow_scale

Real orb5x::FieldsVariables::flow_scale = 1.0

Multiplicative scale applied to equilibrium flow.

k_offset

int orb5x::FieldsVariables::k_offset = 0

Global toroidal-plane offset of this spatial rank.

kthrhomax

Real orb5x::FieldsVariables::kthrhomax = 0.0

Maximum retained perpendicular k_theta rho.

mfilt1

int orb5x::FieldsVariables::mfilt1 = -2000

Minimum retained poloidal Fourier mode.

mfilt2

int orb5x::FieldsVariables::mfilt2 = 2000

Maximum retained poloidal Fourier mode.

n_flux_tube

int orb5x::FieldsVariables::n_flux_tube = 0

Number of toroidal flux-tube sectors.

nblocks

int orb5x::FieldsVariables::nblocks = 1

Number of radial blocks used by field operations.

nchi

int orb5x::FieldsVariables::nchi = 0

Number of poloidal field intervals.

nchip

int orb5x::FieldsVariables::nchip = 0

Poloidal grid size including the periodic endpoint.

nfilt1

int orb5x::FieldsVariables::nfilt1 = 0

Minimum retained toroidal Fourier mode.

nfilt2

int orb5x::FieldsVariables::nfilt2 = 8

Maximum retained toroidal Fourier mode.

nidbas

int orb5x::FieldsVariables::nidbas = 0

B-spline polynomial degree.

nl_compute_fields

bool orb5x::FieldsVariables::nl_compute_fields = false

Solve self-consistent fields during the time loop.

nl_gradgyr

bool orb5x::FieldsVariables::nl_gradgyr = false

Include gradients of gyroaveraged field quantities.

nl_neoclassical

bool orb5x::FieldsVariables::nl_neoclassical = false

Enable axisymmetric neoclassical field treatment.

nphi

int orb5x::FieldsVariables::nphi = 0

Number of local toroidal field intervals.

nphip

int orb5x::FieldsVariables::nphip = 0

Local toroidal grid size including the periodic endpoint.

ns

int orb5x::FieldsVariables::ns = 0

Number of radial field intervals.

nsel_dft_method

int orb5x::FieldsVariables::nsel_dft_method = 0

Discrete-Fourier-transform implementation selector.

nsel_filter

int orb5x::FieldsVariables::nsel_filter = 1

Fourier-filter selector; see NSelFilter.

nsel_fix_fields

int orb5x::FieldsVariables::nsel_fix_fields = 0

Selector for externally fixed field components.

nsel_getfield

int orb5x::FieldsVariables::nsel_getfield = 0

Marker field-interpolation selector.

nsel_inner_bc

int orb5x::FieldsVariables::nsel_inner_bc = 2

Magnetic-axis boundary selector; see NSelInnerBC.

nsel_noise_filter

int orb5x::FieldsVariables::nsel_noise_filter = 0

Noise-filter stencil selector.

nsel_pot_profile

int orb5x::FieldsVariables::nsel_pot_profile = 0

Prescribed potential-profile selector.

nsel_setrho

int orb5x::FieldsVariables::nsel_setrho = 0

Charge-density deposition selector.

nsel_strong

int orb5x::FieldsVariables::nsel_strong = 0

Strong-form/weak-form field-evaluation selector.

sfmax

Real orb5x::FieldsVariables::sfmax = 0.0

Upper normalized radial boundary of the field mesh.

sfmin

Real orb5x::FieldsVariables::sfmin = 0.0

Lower normalized radial boundary of the field mesh.

sreverse_smooth

Real orb5x::FieldsVariables::sreverse_smooth = 0.01

Smoothing width around the flow-reversal radius.

stride_refresh_larmor

int orb5x::FieldsVariables::stride_refresh_larmor = 0

Steps between gyroaveraging-table refreshes; zero uses policy default.

---

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

• globals.hpp