korc_types Module

$R$ component of the vector field variable.

$\phi$ component of the vector field variable.

$Z$ component of the vector field variable.

$R$ component of the vector field variable.

$\phi$ component of the vector field variable.

$Z$ component of the vector field variable.

$R$ component of the vector field variable.

$\phi$ component of the vector field variable.

$Z$ component of the vector field variable.

$R$ component of the vector field variable.

$\phi$ component of the vector field variable.

$Z$ component of the vector field variable.

Number of MPI processes.

Rank in WORLD COMMON communicator.

Rank in mpi_topo communicator

MPI communicator for a certain topology.

Characteristic velocity. This is fixed to the speed of $c$.

Characteristic length scale calculated as $c$ times the relativistic time scale.

Characteristic particle mass. This is equal to the electron mass $m_e$.

Characteristic particle charge. This is equal to the electron charge $q_e$.

Characteristic particle density. This is equal to $1/l^3$, with $l$ the characteristic length.

Characteristic electric field $E_0$. Usually $E_0$ at the magnetic axis.

Characteristic magnetic field $B_0$. Usually $B_0$ at the magnetic axis.

Characteristic energy. This is equal to $m_e c^2$.

Characteristic pressure.

Characteristic plasma temperature (Joules). This is equal to $m_e c^2$.

Absolute path to KORC's input file.

Absolute path to the outputs' folder.

Number of open MP threads per MPI process used in the simulation.

Flag to indicate if the simulations proceeds (restart=T) or not (restart=F). Restart simulation that exited before simulation_time reached.

Flag to indicate if the simulations continues (proceed=T) or not (proceed=F). Append simulation results after previous simulation_time reached.

Flag to begin a new simulation, reinitializing from restart file state

Total simulation time in seconds.

Time between snapshots in time of the simulation.

Time between overwrites of restart file in time of the simulation.

Time step in the simulation as a fraction of the relativistic electron gyro-period $\tau_e = 2\pi\gamma m_e/eB_0$.

Current physical time in the simulation.

Initial time iteration in the simulation, this is different from zero in case is a restarting simulation.

Current time iteration in the simulation, this is different from zero in case is a restarting simulation.

Time at the beginning of a run with proceed=T

Number of time steps needed for evolving the electrons up to "simulation_time".

Time iteration offset used to decide when the outputs are generated.

Time iteration offset used to decide when the restart files are generated.

Number of snapshots in time for generating the output files.

Number of different populations of simulated relativistic electrons in KORC.

Minimum allowed energy of simulated electrons.

Minimum allowed relativistic factor $\gamma$ of simulated electrons.

Flag to indicate if synchrotron radiation losses are included (radiation=T) or not (radiation=F).

Flag to indicate if collisionsare included (collisions=T) or not (collisions=F).

String with the name of the collisions model to be used in the simulation.

String with the name of the model for the fields and plasma profiles.

String with the name of the model for the fields and plasma profiles.

List of electron variables to include in the outputs.

Flag to indicate whether we allow HDF5 to show warnings during runtime (HDF5_error_handling=1) or not (HDF5_error_handling=0)

An instance of the KORC_MPI derived type.

An instance of the CHARCS_PARAMS derived type.

String with the name of the orbit model ('FO' or 'GC').

String with the name of the field evaluation method for analytical fields ('interp' or 'eqn')

Flag to get_fields to control whether cartesian to cylindrical coordinate transformation needs to be performed

Flag to decouple spatial-dependence of evolution

number of particles per vectorized chunk

Cartesian coordinates of the electrons' position. dim(X) = (3,SPECIES::ppp).

Cartesian components of the electrons' velocity. dim(V) = dim(X).

Cartesian coordinates of the electrons' guiding-center position.

Coordinates of the electrons' position in cylindrical or toroidal coordinates.

Placeholder coordinates of the electrons' position in cylindrical coordinates for GC orbit model.

Placeholder of the electrons' parallel momentum for the GC orbit model

Cartesian components of the electric field felt by each electron. dim(E) = dim(X).

Cartesian components of the magnetic field felt by each electron. dim(B) = dim(X).

Cartesian components of the gradient of the R-component of the magnetic field felt by each electron. dim(B) = dim(X).

Cartesian components of the gradient of the PHI-component of the magnetic field felt by each electron. dim(B) = dim(X).

Cartesian components of the gradient of the Z-component of the magnetic field felt by each electron. dim(B) = dim(X).

Cylindrical components of the gradient of magnitude of magnetic field felt by each electron. dim(B) = dim(X).

Cylindrical components of the curl of the magnetic field unit vector felt by each electron. dim(B) = dim(X).

RHS of equations of motion for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Cash-Karp Runge-Kutta coefficient for GC orbit model

Electron density seen by each electron. dim(ne) = (1,SPECIES::ppp).

Electron temperature seen by each electron. dim(Te) = (1,SPECIES::ppp).

Zeff seen by each electron. dim(Zeff) = (1,SPECIES::ppp).

Instantaneous relativistic $\gamma = 1/\sqrt{1 - v^2/c^2}$ factor of each electron in the simulation.

Instantaneous pitch angle of each electron in the simulation.

Magnetic moment of each electron in the simulation.

Instantaneous radiated power by each electron in the simulation.

Instantaneous input power of each electron due to the electric field acceleration.

Flag for each particle to decide whether it is contained

Flag for each particle to decide whether it is part of the high energy population

Flag for each particle to decide whether it is initialized

An auxiliary scalar variable for each electron.

Weight of each electron. This is used when sampling weighted PDFs and in the synthetic camera diagnostic.

Hint for M3D_C1 interpolation.

An instance of the PARTICLES derived type.

Flag to decide whether a given electron is a runaway (runaway=T) or not (runaway=F).

String describing the type of initial spatial distribution for each electron species.

String describing the type of initial energy distribution for each electron species.

String describing the type of initial pitch-angle distribution for each electron species.

Initial energy of each electron species in case of using an initial mono-energetic distribution.

Corresponding relativisitc factor of each electron species in case of using an initial mono-energetic distribution.

Initial pitch-angle of each electron species in case of using an initial mono-pitch-angle distribution.

Minimum and maximum energy limits of a given initial non-mono-energetic distribution.

Minimum and maximum pitch-angle limits of a given initial non-mono-pitch-angle distribution.

The mean electron cyclotron frequency of each electron species.

The mean relativistic electron cyclotron frequency of each electron species.

Charge of each species.

Mass of each species.

Number of computational particles used to simulate each electron species.

Number of computational particles initialized for each electron species to give room for sources of additional electrons

Radial position of the center of the electrons' initial spatial distribution.

Azimuthal position of the electrons' initial spatial distribution, in case of using a disk at a certain poloidal section.

Height of the center of the electrons' initial spatial distribution.

Minimum minor radius of the electrons' initial spatial distribution.

Maximum minor radius of the electrons' initial spatial distribution.

Exponential falloff or standard deviation of a non-uniform radial distribution of electrons.

Shear factor used to generate an initial spatial distribution with an elliptic poloidal cross section.

Variance of the first dimension of a 2D Gaussian, spatial distribution function

Variance of the second dimension of a 2D Gaussian, spatial distribution function

Angle of counter-clockwise rotation (in degrees) of 2D Gaussian distribution relative to R,Z

Maximum value of the argument of the 2D gaussian exponential, used for an indicator function that limits the region of MH sampling

Initial position in Cartesian coordinates for tracer particle

Magnitude of the toroidal magnetic field $B_0$.

Plasma edge $r_{edge}$ as measured from the magnetic axis.

Radial position of the magnetic axis $R_0$

Safety factor at the plasma edge.

Safety factor at the magnetic axis $q_0$.

$\lambda$ parameter of $q(r)$.

@deprecated Parameter not used anymore.

Sign of $B_\vartheta(r)$. This depends on current_direction, Bp_sign=1 for current_direction='PARALLEL', and Bp_sign=-1 for current_direction='ANTI-PARALLEL'.

Direction of plasma current: PARALLEL or ANTI-PARALLEL to the toroidal magnetic field.

radial electric field amplitude.

mode location rmn

mode width sigmamn

Radial grid.

Azimuthal grid.

Z grid.

An instance of the KORC derived data type A_FIELD.

KORC 3-D vector field of the pre-computed electric field.

KORC 3-D vector field of the pre-computed magnetic field.

KORC 2-D vector field of the pre-computed electric field.

KORC 3-D vector field of the pre-computed magnetic field.

KORC 3-D vector field of the gradient of the magnitude of the pre-computed magnetic field.

KORC 3-D vector field of the curl of the unit vector in the direction of the pre-computed magnetic field.

An instance of the KORC derived type MESH.

Name for dynamical, analytic, electric field model to be added to

interpolated E field

Dimensions of the KORC vector field. dims=(number of grid nodes along $R$, number of grid nodes along $\phi$, number of grid nodes along $Z$).

2-D array for storing the data of the poloidal magnetic flux.

2-D array defining the simulation domain where pre-computed data exist.

3-D array defining the simulation domain where pre-computed data exist.

Characteristic electric field.

Characteristic magnetic field.

Radial position of the magnetic axis.

$Z$ position of the magnetic axis.

Flag to indicate whether a pre-computed magnetic field will be used (Bfield=T) or not (Bfield=F).

Flag to indicate whether a pre-computed magnetic field will be used (Bfield=T) or not (Bfield=F).

Flag to indicate whether a pre-computed poloidal magnetic flux will be used (Bflux=T) or not (Bflux=F).

Flag to indicate whether a pre-computed electric field will be used (Efield=T) or not (Efield=F).

Flag to indicate if a pre-computed magnetic field is in the input file.

Flag to indicate if a pre-computed magnetic field is in the input file.

Flag to indicate if a pre-computed poloidal magnetic flux is in the input file.

Flag to indicate if a pre-computed electric field is in the input file.

Flag to indicate if the pre-computed fields are axisymmetric.

An M3D-C1 magnetic field.

An M3D-C1 Electric field.

An M3D-C1 vector potential.

An instance of the KORC derived data type MESH.

Plasma radius as measured from the magnetic axis

Dimensions of the arrays containing the pre-computed profiles data. dims=(number of grid nodes along $R$, number of grid nodes along $\phi$, number of grid nodes along $Z$).

2-D array defining the simulation domain where pre-computed data exist.

3-D array defining the simulation domain where pre-computed data exist.

$n$ used in $\tanh^n(r)$ of the electron density profile.

$n$ used in $\tanh^n(r)$ of the electron temperature profile.

$n$ used in $\tanh^n(r)$ of the $Z_{eff}$ profile.

Coefficients of the polynomial electron density profile. See detailed description above, a_ne=($a_{0}$,$a_{2}$,$a_{3}$,$a_{4}$).

Coefficients of the polynomial electron temperature profile. See detailed description above, a_ne=($a_{0}$,$a_{2}$,$a_{3}$,$a_{4}$).

Coefficients of the $Z_{eff}$ profile. See detailed description above, a_ne=($a_{0}$,$a_{2}$,$a_{3}$,$a_{4}$).

String containing the type of $Z_{eff}$ profile to be used in the simulation.

$Z_{eff}$ at the magnetic axis.

3-D array for keeping the pre-computed data of the $Z_{eff}$ profile.

2-D array for keeping the pre-computed data of the $Z_{eff}$ profile.

String containing the type of electron density profile to be used in the simulation.

Electron density at the magnetic axis

3-D array for keeping the pre-computed data of the electron density profile.

2-D array for keeping the pre-computed data of the electron density profile.

String containing the type of electron temperature profile to be used in the simulation.

Electron temperature at the magnetic axis

3-D array for keeping the pre-computed data of the electron density profile.

2-D array for keeping the pre-computed data of the electron density profile.

Full path to the HDF5 file containing the pre-computed plasma profiles.

Flag to indicate if the plasma profiles are axisymmetric.