types.hpp File Reference
Base types. More...
Go to the source code of this file.
Detailed Description
Base types.
Define Documentation
#define PARTICLE_R 3 |
#define PARTICLE_T 0 |
Defined keywords for accessing particle point coordinates.
#define PARTICLE_VR 4 |
#define PARTICLE_VX 2 |
#define PARTICLE_VY 4 |
#define PARTICLE_VZ 6 |
#define PARTICLE_W 5 |
#define PARTICLE_X 1 |
#define PARTICLE_Y 3 |
#define PARTICLE_Z 5 |
Typedef Documentation
typedef field_type_e field_diag_type_e |
Field diagnostic type.
- Deprecated:
- Provided for compatibility only. Replaced by multipurpose field type selector field_type_e.
Enumeration Type Documentation
enum bound_e |
Boundary type.
Boundary conditions for solids and simulation box boundaries. See class Bound for more information.
enum coordinate_axis_e |
enum field_extrpl_e |
Field extrapolation mode.
This parameter is used to control the behaviour of the field evaluators outside the defined area. The field value can be extrapolated from the closest defined points (FIELD_EXTRAPOLATE), the field can be mirrored (FIELD_MIRROR), the field evaluator can simply return zero (FIELD_ZERO) or the field evaluator can return not-a-number, NaN (FIELD_NAN ).
enum field_type_e |
Field type.
Indicator for field type.
- Enumerator:
enum geom_mode_e |
Geometry mode enum.
Simulation geometry can be either 1D (MODE_1D), planar 2D (MODE_2D), planar 3D (MODE_3D) or it can be defined as cylindrical symmetrical 2D with coordinates x and r (MODE_CYL).
The geometry mode selects the active axes for calculation and fields. For MODE_1D only x-axis (axis 0) is active. For MODE_2D the x- and y-axes are active (axes 0 and 1). For MODE_CYL the x- and r-axes are active (axes 0 and 1). For MODE_3D the x- and y- and z-axes are active (axes 0, 1 and 2).
Type of diagnostic for trajectories.
O-, P- and Q-axes are diagnostic axes defined by user.
- Enumerator:
DIAG_NONE Dummy diagnostic. Does nothing.
DIAG_T Time (s).
DIAG_X X-axis position (m).
DIAG_VX X-axis velocity (m/s).
DIAG_Y Y-axis position (m).
DIAG_R Radial position (m).
DIAG_VY Y-axis velocity (m/s).
DIAG_VR Radial velocity (m/s).
DIAG_W Angular velocity (rad/s).
DIAG_VTHETA Tangential velocity (m/s).
DIAG_Z Z-axis position (m).
DIAG_VZ Z-axis velocity (m/s).
DIAG_O O-axis position (m).
DIAG_VO O-axis velocity (m/s).
DIAG_P P-axis position (m).
DIAG_VP P-axis velocity (m/s).
DIAG_Q Q-axis position (m).
DIAG_VQ Q-axis velocity (m/s).
DIAG_XP , where direction q is normal to diagnostic plane (rad)
DIAG_YP , where direction q is normal to diagnostic plane (rad)
DIAG_RP , where direction q is normal to diagnostic plane (rad)
DIAG_AP , where direction q is normal to diagnostic plane (rad)
DIAG_ZP , where direction q is normal to diagnostic plane (rad)
DIAG_OP , where direction q is normal to diagnostic plane (rad)
DIAG_PP , where direction q is normal to diagnostic plane (rad)
DIAG_CURR Current (I).
DIAG_EK Kinetic energy (eV).
DIAG_QM Charge per mass (e/u).
DIAG_CHARGE Particle charge (e).
DIAG_MASS Particle mass (u).
Variable Documentation
const char* coordinate_axis_string[] |
String describing axis names without unit.
Contains strings: "x", "y", "r" and "z".
const char* coordinate_axis_string_with_unit[] |
String describing axis names with unit.
Contains strings: "x (m)", "y (m)", "r (m)" and "z (m)".
const char* trajectory_diagnostic_string[] |
String describing diagnostic without unit.
Contains strings: "none", "t", "x", "v_x", "y", ... Greek letters are typed with LaTeX notation for correct output in plots.
const char* trajectory_diagnostic_string_unit[] |
String for separate diagnostic unit.
Contains strings: "", "s", "m", "m/2", "m", ... Greek letters are typed with LaTeX notation for correct output in plots.
const char* trajectory_diagnostic_string_with_unit[] |
String describing diagnostic with unit.
Contains strings: "none ()", "t (s)", "x (m)", "v_x (m/2)", "y (m)", ... Greek letters are typed with LaTeX notation for correct output in plots.