Particle Diagnostics

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

Particle, escaped-particle, and particle-consistency diagnostic outputs.

xgc.particle.*.bp

Variable

Units

Description

Context

gstep

Non-negative integer

XGC global simulation time step for this particle diagnostic output slice.

context

sp_name + "gid"

Positive integer

Global ID of the markers in the sample.

context

sp_name + "nphase"

Positive integer

Number of particle phase variables.

context

sp_name + "num_total"

Non-negative integer

Number of markers in the sample.

context

sp_name + "phase"

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

Selected species particle phase 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. Particles are selected when their global particle ID is positive and divisible by diag_particle_mod. If PTL_G2 is enabled, an additional g2 marker-density column is appended.

context

time

s

Simulation time of step in seconds.

context

tindex

Positive integer

Diagnostic cadence index computed as integer gstep divided by the configured diagnostic period. This index is not the zero-based ADIOS step and need not start at 1 in a restarted or selected product.

context

xgc.escaped_ptls.*.bp

Variable

Units

Description

Context

gstep

Non-negative integer

XGC global simulation time step for this escaped-particle diagnostic output slice.

context

prefix + "dw"

dimensionless

Decoded escaped-particle weight-change payload from the packed particle flag.

context

prefix + "flag"

integer flag

Decoded escaped-particle low-bit status flags for this species.

context

prefix + "gid"

Integer index

Globally unique marker-particle IDs for escaped particles of this species.

context

prefix + "maxgid"

Non-negative integer

Largest globally unique marker-particle ID already assigned for this species when escaped particles are written.

context

prefix + "nphase"

Positive integer

Number of columns in the escaped-particle phase array.

context

prefix + "num_total"

Non-negative integer

Total number of escaped marker particles written for this species in this diagnostic step.

context

prefix + "phase"

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

Escaped-particle phase array with columns [R, Z, phi, rho, w1, w2, mu, w0, g, optional g2, psi, |B|], 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, \(g\) is the phase-space marker density, \(\\psi\) is the poloidal magnetic flux, and \(\|B\|\) is the magnetic-field magnitude. With PTL_G2, g2 is appended after g and before psi and |B|.

context

prefix + "step"

Non-negative integer

Stored escape-step payload decoded from the packed particle flag. This is set on a separatrix escape; a divertor-only output mark does not necessarily update it, so it is not a guaranteed timestamp of the latest output-marking event.

context

time

s

Simulation time of step in seconds.

context

tindex

Positive integer

Diagnostic cadence index computed as integer gstep divided by the configured diagnostic period. This index is not the zero-based ADIOS step and need not start at 1 in a restarted or selected product.

context

particle_check*.bp

Variable

Units

Description

Context

refgid

Integer index

Reference globally unique particle IDs used by the global particle consistency check.

context

refphase

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

Reference particle phase 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. Used by the global particle consistency check.

context

xgc.particle_stream.bp

Variable

Units

Description

Context

e_E

J

Kinetic energy 0.5*mass*vpar^2 + mu*|B| of the tracked particle.

context

e_R

m

Cylindrical major radius of the tracked particle.

context

e_Z

m

Vertical position of the tracked particle.

context

e_gid

Integer index

Global marker ID; join particle samples by ID rather than row position.

context

e_phi

rad

Cylindrical toroidal angle of the tracked particle.

context

e_psi

T m^2

Poloidal magnetic flux divided by 2*pi at the tracked particle.

context

e_psi_c

T m^2

Canonical flux-like coordinate psi + sign(-Bt)*rho*Bphi*R for the tracked particle.

context

e_vpar

m s^-1

Velocity parallel to the magnetic field of the tracked particle.

context

e_w0

dimensionless

Constant particle weight; -1 is written as a divertor-hit sentinel.

context

e_w1

dimensionless

Particle delta-f weight component w1.

context

e_w2

dimensionless

Particle auxiliary weight w2=1-f0/(w0*g), copied from the particle phase array.

context

gstep

Non-negative integer

Global integration step of this particle-stream sample.

context

i_E

J

Kinetic energy 0.5*mass*vpar^2 + mu*|B| of the tracked particle.

context

i_R

m

Cylindrical major radius of the tracked particle.

context

i_Z

m

Vertical position of the tracked particle.

context

i_gid

Integer index

Global marker ID; join particle samples by ID rather than row position.

context

i_phi

rad

Cylindrical toroidal angle of the tracked particle.

context

i_psi

T m^2

Poloidal magnetic flux divided by 2*pi at the tracked particle.

context

i_psi_c

T m^2

Canonical flux-like coordinate psi + sign(-Bt)*rho*Bphi*R for the tracked particle.

context

i_vpar

m s^-1

Velocity parallel to the magnetic field of the tracked particle.

context

i_w0

dimensionless

Constant particle weight; -1 is written as a divertor-hit sentinel.

context

i_w1

dimensionless

Particle delta-f weight component w1.

context

i_w2

dimensionless

Particle auxiliary weight w2=1-f0/(w0*g), copied from the particle phase array.

context