Checkpoint Restart Outputs

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

Checkpoint-restart variables. These files are written for restart fidelity and are not ordinary analysis diagnostics.

restart_dir/xgc.restart*.bp

Variable

Units

Description

Context

3db_rampup_factor

dimensionless

Restart value of the 3D perturbed magnetic-field ramp-up factor.

context

apars

T m

Restart value of perturbed parallel vector potential \(A_{\\parallel}\) on toroidal planes and mesh nodes.

context

cden0_rmp

m^-3

Checkpoint of the per-toroidal-plane Poisson-RHS charge-number-density accumulation, indexed by Runge-Kutta stage and solver iflag during the RMP EM/ES cycle.

context

checkpoint_version

Positive integer

Version index indicating the format of this restart file.

context

dpotsave

V

Restart history of perturbed electrostatic potential on toroidal planes and mesh nodes.

context

inode1

Integer index

One-based global index of the first mesh node assigned to each MPI rank in the checkpoint domain decomposition.

context

jpar0_rmp

m^-2 s^-1

Checkpoint of the per-toroidal-plane Ampere-RHS accumulation for each Runge-Kutta stage during the RMP EM/ES cycle; elementary charge is not included.

context

jpara_diff_integral

A m^-2

Cumulative controller sum of bt_sign*(j_parallel,equilibrium-j_parallel,plasma) over current-drive applications; no physical timestep factor is included.

context

jpara_diff_previous

A m^-2

Exponentially smoothed controller error bt_sign*(j_parallel,equilibrium-j_parallel,plasma), updated as previous=0.8*previous+0.2*current on each current-drive application.

context

loop_voltage

V

Restart value of the loop-voltage profile on mesh nodes.

context

neu_node_dens

m^-3

Checkpointed neutral background density on mesh nodes.

context

neu_node_temp

eV

Checkpointed neutral background temperature on mesh nodes.

context

neu_weight_lost_ebin

simulation-particle weight

Checkpointed sum of lost main-ion particle weights binned by wall node and incident-ion energy, used to determine the neutral recycling source.

context

neu_weight_sum_lost

simulation-particle weight

Checkpointed sum of lost main-ion particle weights, used to normalize the recycled-neutral source.

context

neu_weight_wall_lost

simulation-particle weight

Checkpointed sum of lost main-ion particle weights at each wall node, used to determine the neutral recycling source.

context

nmup1

Positive integer

Number of perpendicular velocity grid points in f0 checkpoint arrays.

context

nnode

Positive integer

Number of 2D mesh nodes.

context

nphi

Positive integer

Number of toroidal mesh planes \(N_{\\mathrm{planes}}\).

context

predictor_ne00_tau

main-ion toroidal transit times

Averaging time used to accumulate predictor_ne00_time_avg.

context

predictor_ne00_time_avg

m^-3

Restart value of the exponentially time-averaged predictor electron-density correction.

context

prefix + "max_used_gid"

Non-negative integer

Largest globally unique marker-particle ID already assigned for this species.

context

rhs_offset0

m^-3

Axisymmetric right-hand-side density offset used when restarting the Poisson/charge solve.

context

sheath_ilost

C

Checkpointed ion charge-loss accumulator on toroidal planes and wall nodes.

context

sheath_lost

C

Checkpointed signed net charge-loss accumulator on toroidal planes and wall nodes.

context

sheath_nphi

Positive integer

Number of toroidal planes in sheath checkpoint arrays.

context

sheath_nwall

Positive integer

Number of wall elements in sheath checkpoint arrays.

context

sheath_pot

V

Checkpointed sheath potential on toroidal planes and wall elements.

context

sp_name + "_f0_delta_T"

eV

Restart value of species temperature perturbation added to the analytic f0 background on mesh nodes.

context

sp_name + "_f0_delta_n"

m^-3

Restart value of species density perturbation added to the analytic f0 background on mesh nodes.

context

sp_name + "_f0_delta_u"

m s^-1

Restart value of species flow perturbation added to the analytic f0 background on mesh nodes.

context

sp_name + "_f0g"

m^-3 eV^-1

Species residual/grid contribution to the f0 distribution function on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].

context

sp_name + "flag"

integer flag

Packed 64-bit ESC_PTL particle state for this checkpoint species, including low status bits, the stored escape-step payload, and the signed fixed-point weight-change payload; this is not the decoded low-bit flag array in xgc.escaped_ptls.*.bp.

context

sp_name + "gid"

Integer index

Globally unique marker-particle IDs for this species.

context

sp_name + "nphase"

Positive integer

Number of columns in the species particle phase checkpoint array.

context

sp_name + "num_arr"

Non-negative integer

Number of checkpointed marker particles for this species written by each MPI rank.

context

sp_name + "num_total"

Non-negative integer

Total number of checkpointed marker particles for this species across all MPI ranks.

context

sp_name + "off_arr"

Non-negative integer

Global particle-array offset for this species for each MPI rank in the checkpoint.

context

sp_name + "phase"

[m, m, rad, m, dimensionless, dimensionless, J/T, dimensionless, m^-3 eV^(-3/2)]

Species particle phase checkpoint array with columns [R, Z, phi, rho, w1, w2, mu, w0, g], where \(R\), \(Z\), and \(\\phi\) are the cylindrical coordinates of the particle, \(\\rho\) is the parallel gyroradius (proxy for \(v_{\\parallel}\)), \(w_1\) is the delta-f weight, \(w_2\) is a weight used in the weight evolution equation, \(\\mu\) is the magnetic moment, \(w_0\) is the full-f weight (from importance sampling), and \(g\) is the phase-space marker density.

context

species.short_label.str() + "_f0_df0g_persistent"

m^-3 eV^-1

Persistent residual df0g distribution retained for later particle transfer on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].

context

species.short_label.str() + "_f0_df0g_persistent_counter"

source-application count

Age counter for persistent residual df0g entries on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].

context

time

s

Simulation time of step in seconds.

context

timestep

Non-negative integer

Simulation time step stored in the checkpoint.

context

totalpe

Positive integer

Number of MPI ranks used when the checkpoint was written.

context

vpdata

Positive integer

Number of parallel velocity grid points in f0 checkpoint arrays.

context