F0 Diagnostics
==============

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

Background distribution-function diagnostic outputs.

xgc.f0.*.bp
-----------

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

   * - Variable
     - Units
     - Description
   * - ``dpot``
     - V
     - Perturbed electrostatic potential on each toroidal plane and 2D mesh node.
   * - ``dpot``
     - V
     - Axisymmetric perturbed electrostatic potential on the 2D mesh.
   * - ``eden_f0``
     - m^-3
     - Electron f0 density at each toroidal plane on the 2D mesh.
   * - ``iden_f0_approx``
     - m^-3
     - Approximate ion f0 density at each toroidal plane and on the 2D mesh, summed over ion gyro-radius bins.
   * - ``imu1m1``
     - Non-negative integer
     - Legacy decomposition metadata: zero-based perpendicular-velocity-grid offset of this write.
   * - ``inode1m1``
     - Positive integer
     - Legacy decomposition metadata: zero-based global node offset of the first local mesh node in this write.
   * - ``iphi``
     - Non-negative integer
     - Legacy decomposition metadata: zero-based toroidal plane index written by this rank.
   * - ``mudata``
     - Positive integer
     - Number of perpendicular velocity grid points.
   * - ``ndata``
     - Positive integer
     - Legacy decomposition metadata: number of local mesh nodes written by this rank.
   * - ``nmup1``
     - Positive integer
     - Number of perpendicular velocity grid points.
   * - ``nnode``
     - Positive integer
     - Number of 2D mesh nodes per plane.
   * - ``nphi``
     - Positive integer
     - Number of toroidal mesh planes :math:`N_{\mathrm{planes}}`.
   * - ``sp_name + "f"``
     - m^-3 eV^-1
     - Full distribution function multiplied by the normalized perpendicular velocity factor, i.e., :math:`v_{\perp} f(v_{\perp}, v_{\parallel})`, on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].
   * - ``sp_name + "f0g"``
     - m^-3 eV^-1
     - Residual/grid contribution to the species f0 distribution function on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].
   * - ``sp_name + "f0n"``
     - dimensionless
     - Particle-to-grid interpolation normalization for the species f0 distribution on [toroidal plane, perpendicular velocity, mesh node, parallel velocity].
   * - ``step``
     - Positive integer
     - Simulation time step index.
   * - ``time``
     - s
     - Simulation time in seconds.
   * - ``vpdata``
     - Positive integer
     - Number of parallel velocity grid points.