mod_equilibrium_params Module

Module containing all equilibrium parameters. All parameters used in the equilibrium submodules are defined here for convenience, including the wave numbers $k_2$ and $k_3$. All of these values are NaN initially, such that variables that are not properly set propagate their value and are easy to spot in follow-up checks.

Variables

TypeVisibility AttributesNameInitial
real(kind=dp), public :: k2

wavenumber in y-direction (Cartesian) or theta-direction (cylindrical)

real(kind=dp), public :: k3

wavenumber in z-direction

real(kind=dp), public :: cte_rho0

general constant usually used for density

real(kind=dp), public :: cte_T0

general constant usually used for temperature

real(kind=dp), public :: cte_B01

general constant usually used for the 01 magnetic field component

real(kind=dp), public :: cte_B02

general constant usually used for the 02 magnetic field component

real(kind=dp), public :: cte_B03

general constant usually used for the 03 magnetic field component

real(kind=dp), public :: cte_v02

general constant usually used for the 02 velocity component

real(kind=dp), public :: cte_v03

general constant usually used for the 03 velocity component

real(kind=dp), public :: cte_p0

general constant usually used for pressure

real(kind=dp), public :: p1

general constant usually used in polynomials

real(kind=dp), public :: p2

general constant usually used in polynomials

real(kind=dp), public :: p3

general constant usually used in polynomials

real(kind=dp), public :: p4

general constant usually used in polynomials

real(kind=dp), public :: p5

general constant usually used in polynomials

real(kind=dp), public :: p6

general constant usually used in polynomials

real(kind=dp), public :: p7

general constant usually used in polynomials

real(kind=dp), public :: p8

general constant usually used in polynomials

real(kind=dp), public :: alpha

general constant used in various expressions

real(kind=dp), public :: beta

general constant used in various expressions

real(kind=dp), public :: delta

general constant used in various expressions

real(kind=dp), public :: theta

general constant used in various expressions

real(kind=dp), public :: tau

general constant used in various expressions

real(kind=dp), public :: lambda

general constant used in various expressions

real(kind=dp), public :: nu

general constant used in various expressions

real(kind=dp), public :: r0

general constant usually used for radius

real(kind=dp), public :: rc

general constant usually used for radius

real(kind=dp), public :: rj

general constant usually used for radius

real(kind=dp), public :: Bth0

general constant usually used in cylindrical geometry

real(kind=dp), public :: Bz0

general constant usually used in cylindrical geometry

real(kind=dp), public :: V

general constant usually used in shear-related setups

real(kind=dp), public :: j0

general constant usually used for current

real(kind=dp), public :: g

general constant usually used for gravity

logical, public :: eq_bool

general boolean for varied use, defaults to False

Subroutines

public subroutine init_equilibrium_params()

Initialises all variables defined at module scope to NaN, including the wave numbers. This ensures that these have to be explicitly set.

None