General representation of a marker. More...

#include <particle.h>

Data Fields
real	r

real	phi

real	z

real	ppar

real	mu

real	zeta

real	rprt

real	phiprt

real	zprt

real	p_r

real	p_phi

real	p_z

real	mass

real	charge

int	anum

int	znum

real	weight

real	time

real	mileage

real	cputime

real	rho

real	theta

integer	id

integer	endcond

integer	walltile

real	B_r

real	B_phi

real	B_z

real	B_r_dr

real	B_phi_dr

real	B_z_dr

real	B_r_dphi

real	B_phi_dphi

real	B_z_dphi

real	B_r_dz

real	B_phi_dz

real	B_z_dz

a5err	err

Detailed Description

General representation of a marker.

This struct is a self-consistent representation of a marker which can be constructed from any input and from which any simulation marker struct can be constructed. This structure is not intended to be used during the simulation, but before and after for storing marker data, and making it easy to switch between different marker types and construct markers from inputs.

Whenever marker properties are changed, it is the responsibility of the function performing the change to make sure all parameters remain consistent. For example, magnetic field must be updated when marker position changes.

Definition at line 40 of file particle.h.

Field Documentation

◆ r

real particle_state::r

Guiding center R coordinate [m]

Definition at line 41 of file particle.h.

◆ phi

real particle_state::phi

Guiding center phi coordinate [rad]

Definition at line 42 of file particle.h.

◆ z

real particle_state::z

Guiding center z coordinate [m]

Definition at line 43 of file particle.h.

◆ ppar

real particle_state::ppar

Parallel momentum [kg m/s]

Definition at line 44 of file particle.h.

◆ mu

real particle_state::mu

Magnetic moment [J/T]

Definition at line 45 of file particle.h.

◆ zeta

real particle_state::zeta

Gyroangle [rad]

Definition at line 46 of file particle.h.

◆ rprt

real particle_state::rprt

Particle R coordinate [m]

Definition at line 47 of file particle.h.

◆ phiprt

real particle_state::phiprt

Particle phi coordinate [phi]

Definition at line 48 of file particle.h.

◆ zprt

real particle_state::zprt

Particle z coordinate [m]

Definition at line 49 of file particle.h.

◆ p_r

real particle_state::p_r

Momentum r component [kg m/s]

Definition at line 50 of file particle.h.

◆ p_phi

real particle_state::p_phi

Momentum phi component [kg m/s]

Definition at line 51 of file particle.h.

◆ p_z

real particle_state::p_z

Momentum z component [kg m/s]

Definition at line 52 of file particle.h.

◆ mass

real particle_state::mass

Mass [kg]

Definition at line 53 of file particle.h.

◆ charge

real particle_state::charge

Charge [C]

Definition at line 54 of file particle.h.

◆ anum

int particle_state::anum

Atomic mass number of marker species

Definition at line 55 of file particle.h.

◆ znum

int particle_state::znum

Charge number of marker species

Definition at line 56 of file particle.h.

◆ weight

real particle_state::weight

Marker weight

Definition at line 57 of file particle.h.

◆ time

real particle_state::time

Marker simulation time [s]

Definition at line 58 of file particle.h.

◆ mileage

real particle_state::mileage

Duration this marker has been simulated [s]

Definition at line 59 of file particle.h.

◆ cputime

real particle_state::cputime

Marker wall-clock time [s]

Definition at line 60 of file particle.h.

◆ rho

real particle_state::rho

Marker rho coordinate

Definition at line 61 of file particle.h.

◆ theta

real particle_state::theta

Marker poloidal coordinate [rad]

Definition at line 62 of file particle.h.

◆ id

integer particle_state::id

Arbitrary but unique ID for the marker

Definition at line 63 of file particle.h.

◆ endcond

integer particle_state::endcond

Marker end condition

Definition at line 64 of file particle.h.

◆ walltile

integer particle_state::walltile

ID of walltile if marker has hit the wall

Definition at line 65 of file particle.h.

◆ B_r

real particle_state::B_r

Magnetic field R component at (r, phi, z) [T]

Definition at line 66 of file particle.h.

◆ B_phi

real particle_state::B_phi

Magnetic field phi component at (r, phi, z) [T]

Definition at line 67 of file particle.h.

◆ B_z

real particle_state::B_z

Magnetic field z component at (r, phi, z) [T]

Definition at line 68 of file particle.h.

◆ B_r_dr

real particle_state::B_r_dr

dB_R/dR at (r, phi, z) [T/m]

Definition at line 69 of file particle.h.

◆ B_phi_dr

real particle_state::B_phi_dr

dB_phi/dR at (r, phi, z) [T/m]

Definition at line 70 of file particle.h.

◆ B_z_dr

real particle_state::B_z_dr

dB_z/dR at (r, phi, z) [T/m]

Definition at line 71 of file particle.h.

◆ B_r_dphi

real particle_state::B_r_dphi

dB_R/dphi at (r, phi, z) [T/m]

Definition at line 72 of file particle.h.

◆ B_phi_dphi

real particle_state::B_phi_dphi

dB_phi/dphi at (r, phi, z) [T/m]

Definition at line 73 of file particle.h.

◆ B_z_dphi

real particle_state::B_z_dphi

dB_z/dphi at (r, phi, z) [T/m]

Definition at line 74 of file particle.h.

◆ B_r_dz

real particle_state::B_r_dz

dB_R/dz at (r, phi, z) [T/m]

Definition at line 75 of file particle.h.

◆ B_phi_dz

real particle_state::B_phi_dz

dB_phi/dz at (r, phi, z) [T/m]

Definition at line 76 of file particle.h.

◆ B_z_dz

real particle_state::B_z_dz

dB_z/dz at (r, phi, z) [T/m]

Definition at line 77 of file particle.h.

◆ err

a5err particle_state::err

error flag

Definition at line 79 of file particle.h.

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

particle.h

Data Fields