Units Outputs
=============

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

Unit-conversion and normalization metadata written by XGC.

The non-ADIOS ``units.m`` and ``units.txt`` helper files are not generated through the XGC I/O wrapper and remain outside this generated table.

xgc.units.bp
------------

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

   * - Variable
     - Units
     - Description
   * - ``diag_1d_period``
     - Positive integer
     - Input parameter diag_1d_period, i.e. output frequency of 1D diagnostics.
   * - ``eq_axis_b``
     - T
     - Magnetic field at the magnetic axis
   * - ``eq_axis_r``
     - m
     - Major radius at the magnetic axis
   * - ``eq_axis_z``
     - m
     - Height at the magnetic axis
   * - ``eq_den_v1``
     - :math:`\mathrm{m^{-3}}`
     - Plasma density of eq_den_v1. This value gives a characteristic density value ONLY when an analytic profile is used.
   * - ``eq_tempi_v1``
     - eV
     - Ion temperature of eq_tempi_v1. This value gives a characteristic temperature value ONLY when an analytic profile is used.
   * - ``eq_x_psi``
     - :math:`\mathrm{ T m^2 }`
     - Poloidal flux (over :math:`2\pi`) at the (first) X-point
   * - ``eq_x_r``
     - m
     - Major radius at the (first) X-point
   * - ``eq_x_z``
     - m
     - Height at the (first) X-point
   * - ``sml_dt``
     - :math:`\mathrm{s}`
     - Time step :math:`\Delta t` in seconds. Note that the unit is different from the input parameter `sml_dt` which is given in units of toroidal transit time.
   * - ``sml_totalpe``
     - Positive integer
     - Number of MPI processors
   * - ``sml_tran``
     - :math:`\mathrm{s}`
     - Ion transit time of [sml_en_order_kev] main ion. :math:`\frac{2 \pi R}{\sqrt{2 E/m}}`
   * - ``sml_wedge_n``
     - Positive integer
     - Number of wedges of simulation domain to cover :math:`2\pi`.
   * - ``sp_name + "_ptl_charge_eu"``
     - :math:`e`
     - Input parameter ptl_charge_eu, i.e., the species charge number (charge in units of elementary charge :math:`e`).
   * - ``sp_name + "_ptl_mass_au"``
     - :math:`u`
     - Input parameter ptl_mass_au, i.e., the species mass in atomic mass units (hydrogen mass :math:`m_{\mathrm{H}}~\approx~1u`).