Equilibrium And RMP Outputs

This page is generated from in-code XGC I/O metadata by utils/python/document_outputs.py.

Equilibrium, magnetic-field, and resonant magnetic perturbation outputs.

xgc.bfield.bp

Variable	Units	Description
bfield	T	Magnetic field vector
n_n	Positive number	Number of grid vertices
psi	T m^2	Magnetic flux

xgc.bfieldm.bp

Variable	Units	Description
N	Positive integer	Number of midplane points (1000).
abs_bphi	T	Absolute value of toroidal magnetic field.
dpdr	Tm	\(\frac{d\psi}{dr}\)
psi_n	dimensionless	Poloidal magnetic flux normalized by the X-point value, \(\psi/\psi_X\).
rmajor	m	Major radius.
z	m	Z(height) at the magnetic axis.

xgc.equil.bp

Variable	Units	Description
bp_sign	Normalized	Direction of poloidal field (1 or -1)
bt_sign	Normalized	Direction of toroidal field (1 or -1)
eq_B_R_rz	T	Radial magnetic field component on rectangular grid points
eq_B_Z_rz	T	Z magnetic field component on rectangular grid points
eq_B_phi_rz	T	Toroidal magnetic field component on rectangular grid points
eq_I	T m	B_{tor} R as a function of flux label (Poloidal current function)
eq_PEST_angle_rz	rad	PEST coordinate on rectangular grid points
eq_VMEC_angle_rz	rad	VMEC coordinate on rectangular grid points
eq_axis_b	T	Magnetic field at the magnetic axis
eq_axis_r	m	Major radius at the magnetic axis
eq_axis_z	m	Z (height) at the magnetic axis
eq_max_r	m	Maximum major radius of interpolation boundary
eq_max_z	m	Maximum height of interpolation boundary
eq_min_r	m	Minimum major radius of interpolation boundary
eq_min_z	m	Minimum height of interpolation boundary
eq_mp	Positive integer	Number of planes in input grid (stellarator only)
eq_mpsi	Positive integer	Number of psi (poloidal flux) grid points
eq_mr	Positive integer	Number of horizontal R grid points
eq_mz	Positive integer	Number of vertical Z grid points
eq_psi_grid	T m^2	Poloidal flux on the psi grid points
eq_psi_norm	T m^2	Poloidal flux used for normalization
eq_psi_rz	T m^2	Poloidal flux on the rectangular grid points
eq_x_psi	T m^2	Poloidal flux at the first (lower) X-point
eq_x_r	m	Major radius at the first (lower) X-point
eq_x_z	m	Height at the first (lower) X-point
nphi	Positive integer	Number of toroidal mesh planes \(N_{\mathrm{planes}}\)
periodicity	Positive integer	Toroidal periodicity from VMEC or torus wedge number

xgc.rmp_deltaa.bp

Variable	Units	Description
deltaa	Wb	RMP perturbation of the parallel vector potential.
n_n	Positive integer	Number of mesh nodes per plane.
n_phi	Positive integer	Number of toroidal mesh planes \(N_{\mathrm{planes}}\).
ntor	integer mode number	Toroidal mode numbers for RMP simulations.
num_ntor	Positive integer	Number of toroidal mode numbers for RMP simulations, \(1 + ptb\_3db\_num\_ntor\).

xgc.rmp_residual.bp

Variable	Units	Description
Apar_mn	T m	Parallel vector-potential Fourier amplitudes by toroidal mode, poloidal mode, and flux surface.
dApar	T m	Perturbed parallel vector-potential correction on mesh nodes and toroidal planes.
dApar_mn	T m	Parallel vector-potential correction Fourier amplitudes by toroidal mode, poloidal mode, and flux surface.
damp_fac	dimensionless	Damping factor applied to each RMP Fourier mode.
mpol	Integer mode number	Poloidal mode numbers used in the RMP residual diagnostic.
nnode	Positive integer	Number of mesh nodes in the RMP residual diagnostic.
npsi	Positive integer	Number of radial flux-surface samples for the RMP residual diagnostic.
ntor	Integer mode number	Toroidal mode numbers used in the RMP residual diagnostic.
num_mpol	Positive integer	Number of poloidal mode numbers in the RMP residual diagnostic.
num_ntor	Positive integer	Number of toroidal mode numbers in the RMP residual diagnostic.
psi_res	dimensionless	Normalized poloidal flux values on the residual diagnostic flux-surface grid.
rampup_factor	dimensionless	RMP ramp-up factor applied at this diagnostic time.
rmp_residual	T m	RMP Ampere residual by toroidal and poloidal Fourier mode.
time	s	Simulation time for the RMP damping-factor residual diagnostic.