Source And Transport Profile Outputs
====================================

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

Source, current-drive, collision-convergence, loop-voltage, and transport-profile diagnostic outputs.

xgc.col_conv_status.bp
----------------------

.. list-table::
   :header-rows: 1
   :widths: 25 20 55

   * - Variable
     - Units
     - Description
   * - ``convergence_status``
     - integer flag
     - Collision solver convergence status at each toroidal plane and mesh node. Status codes are -5: NaN or Inf found, -4: maximum Picard iterations reached, -3: too many negative distribution-function values after the solve, -2: positivity correction failed, -1: conservation check failed before the first Picard solve, 0: not attempted, 1: converged successfully, 2: still in progress/internal transient state.
   * - ``n_subcycles``
     - Non-negative integer
     - Number of collision subcycles used at each toroidal plane and mesh node.

xgc.current_drive.bp
--------------------

.. list-table::
   :header-rows: 1
   :widths: 25 20 55

   * - Variable
     - Units
     - Description
   * - ``jpar_bg``
     - A m^-2
     - Equilibrium parallel current density :math:`j_{\parallel}=\hat{b}\cdot(\nabla\times B)/\mu_0` on mesh nodes.
   * - ``jpar_bg_fs_avg``
     - A m^-2
     - Flux-surface-averaged equilibrium parallel current density on mesh nodes.
   * - ``n_n``
     - Positive integer
     - Number of mesh nodes per plane.

xgc.diffusion_profiles.bp
-------------------------

.. list-table::
   :header-rows: 1
   :widths: 25 20 55

   * - Variable
     - Units
     - Description
   * - ``density``
     - m^-3
     - Flux-surface-averaged density profiles on [species, sample, flux surface].
   * - ``flow``
     - m s^-1
     - Flux-surface-averaged parallel-flow profiles on [species, sample, flux surface].
   * - ``n_samples``
     - Positive integer
     - Number of buffered time samples in each diffusion-profile diagnostic output.
   * - ``n_species``
     - Positive integer
     - Number of non-adiabatic species in the diffusion-profile diagnostic.
   * - ``n_surf``
     - Positive integer
     - Number of flux-surface grid points in the diffusion-profile diagnostic.
   * - ``psi``
     - T m^2
     - Poloidal magnetic flux :math:`\psi/(2\pi)`.
   * - ``steps``
     - Non-negative integer
     - Simulation time steps corresponding to buffered diffusion-profile samples.
   * - ``temp``
     - eV
     - Flux-surface-averaged temperature profiles on [species, sample, flux surface].
   * - ``time``
     - s
     - Simulation time of step in seconds.

xgc.loop_vol.bp
---------------

.. list-table::
   :header-rows: 1
   :widths: 25 20 55

   * - Variable
     - Units
     - Description
   * - ``jpara_diff_current``
     - A m^-2
     - Current difference between the XGC parallel plasma current density and the MHD-equilibrium parallel current density.
   * - ``jpara_diff_integral``
     - A m^-2
     - Cumulative controller sum of the difference between the XGC parallel plasma current density and the MHD-equilibrium parallel current density.
   * - ``jpara_diff_previous``
     - A m^-2
     - Smoothed previous difference between the XGC parallel plasma current density and the MHD-equilibrium parallel current density.
   * - ``loop_voltage``
     - V
     - Loop voltage. The corresponding toroidal electric field is :math:`E_{\phi}=V_{\mathrm{loop}}/(2\pi R)`, so positive loop voltage implies an electric field in the positive toroidal direction.
   * - ``step``
     - Positive integer
     - Simulation time step index.
   * - ``time``
     - s
     - Simulation time of step in seconds.