species Module

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Main physical properties of the species, see namelist documentation.

Common combinations of species properties

Common combinations of species properties

Common combinations of species properties

Common combinations of species properties

Common combinations of species properties

Provides offsets to parallel flow shear drive term

Provides offsets to parallel flow shear drive term

Parameters associated with a few initialisation options, including Orszag-Tang.

Parameters associated with a few initialisation options, including Orszag-Tang.

Parameters associated with a few initialisation options, including Orszag-Tang.

Parameters associated with a few initialisation options, including Orszag-Tang.

nu_h controls a hyperviscous term embedded in the collision operator

Artificial factor multiplying the Bessel function argument

Parameters associated with analytic slowing-down distribution

Parameters associated with analytic slowing-down distribution

Flags to identify the species type and the background distribution treatment

Flags to identify the species type and the background distribution treatment

Does the related namelist exist in the target input file?

Used to hold the specific index of numbered namelists

Do we want to skip the read step in init?

Do we want to skip the broadcast step in init?

Do we want to skip the smaart defaults in init?

Specifies the electron mass used in calculating the slowing down parameters in simulations without kinetic electrons.

Number of kinetic species to evolve.

Specify the ion charge factor used in calculating the slowing down parameters. If not specified that will attempt to calculate from the kinetic ion species.

Does the related namelist exist in the target input file?

Used to hold the specific index of numbered namelists

Do we want to skip the read step in init?

Do we want to skip the broadcast step in init?

Do we want to skip the smaart defaults in init?

Multiplies the argument of the Bessel function for this species. Useful for exploring the effect of the Bessel functions.

Set the normalised density for this species

Parameter used for a few specific initial condition types.

Select which type of background distribution should be assumed for this species. Must be one of:

Normalised inverse density gradient: $-\frac{1}{n}\frac{dn}{d \rho_N}$ (Note here $\rho_N$ is the normalised radius $\frac{\rho}{L_\textrm{ref}}$.

Normalised mass of this species

Set the species hyper collision frequency used in the pitch angle scattering collision operator if [[collision_knobs::hypermult]] is true.

Set the normalised species temperature

Parameter used for a few specific initial condition types.

Parameter used for a few specific initial condition types.

Normalised inverse temperature gradient: $-\frac{1}{T}\frac{dT}{d \rho_N}$ (Note here $\rho_N$ is the normalised radius $\frac{\rho}{L_\textrm{ref}}$.

Sets the characterisation of the species. Should be one of

Parameter used for a few specific initial condition types.

Controls an energy independent part of a source term.

Controls an energy dependent part of a source term.

Part of the sdanalytic slowing down model. See G. Wilkie thesis.

Part of the sdanalytic slowing down model. See G. Wilkie thesis.

Sets the normalised species-species collisionality frequency. For species s, vnewk = nu_ss Lref/vref where Lref is the reference length, vref is the reference thermal speed (not the thermal speed of species s!), $\nu_{ss}=\sqrt{2}\pi n_s Z_s^4 e^4 \log(\lambda)/\sqrt{m_s}T^{3/2}_s$ is a dimensional collision frequency, e is the proton charge, $\log(\lambda)$ is the Coloumb logarithm, and $Z_s,T_s,n_s,m_s$ are the (charge, temperature, density, mass) of species s. (The dimensional collision frequency given here is in Gaussian units. For SI units, include an extra factor $(4\pi\epsilon_0)^2$ in the denominator of the definition of $\nu_{ss}$.

Normalised species charge