1D Diagnostics
==============

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

Flux-surface and volume-integrated one-dimensional diagnostic outputs.

xgc.oneddiag.bp
---------------

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

   * - Variable
     - Units
     - Description
   * - ``cden00_1d``
     - m^-3
     - Flux-surface averaged total charge density
   * - ``eden00_1d``
     - m^-3
     - Flux-surface averaged electron charge density
   * - ``gsamples``
     - Positive integer
     - Number of samples (for evenly spaced psi00)
   * - ``gstep``
     - Non-negative integer
     - XGC global simulation time step for this 1D diagnostic output slice.
   * - ``iden00_1d``
     - m^-3
     - Flux-surface averaged ion charge density
   * - ``pot00_1d``
     - V
     - Flux averaged electrostatic potential
   * - ``psi``
     - Normalized
     - Normalized poloidal magnetic flux at each output on each flux surface
   * - ``psi00``
     - T m^2
     - Unnormalized poloidal magnetic flux at each output on each flux surface
   * - ``psi_mks``
     - T m^2
     - Unnormalized poloidal magnetic flux at each output on each flux surface
   * - ``samples``
     - Positive integer
     - Number of samples (i.e. number of flux surfaces)
   * - ``time``
     - s
     - Simulation time at each output in seconds
   * - ``tindex``
     - Positive integer
     - Index of diagnostic output (gstep/diagnostic period). Values: 1, 2, ..., # outputs
   * - ``tmp_info``
     - [m^-3, m/s, m/s, m/s, m^2 s^-1, T m^2 s^-1, eV, eV, J T m^2 s^-1, T m^3 s^-2, T m^3 s^-2, T m^2 s^-1, J T m^2 s^-1, m/s, T m s^-1, (T m)^2, T m^2 s^-1, J T m^2 s^-1, m^-3]
     - Flux-surface 1D diagnostic [species]_[channel]_1d on the psi/psi_mks grid; channel is one of [gc_density, gc_toroidal_flow, gc_poloidal_flow, parallel_flow, tor_angular_momentum, radial_flux, parallel_mean_en, perp_temperature, radial_en_flux, radial_mom_flux_ExB, radial_mom_flux, radial_flux_ExB, radial_en_flux_ExB, poloidal_ExB_flow, vpar_x_B, grad_psi_sqr, radial_flux_3db, radial_en_flux_3db, marker_density]. This group is evaluated with full-f particle weights only; in total-f or delta-f mode it should be interpreted as the sampled full-f marker contribution rather than the complete physical plasma moment. Radial fluxes are relative to the poloidal flux :math:`\psi` and should be divided by the flux-surface average :math:`\langle \|\nabla\psi\| \rangle`, or by the square root of [i,e]_grad_psi_sqr_1d, to convert to a radial flux per unit area. All quantities except density are normalized to the density/particle weight.
   * - ``tmp_info``
     - [m^-3, m/s, m/s, m/s, m^2 s^-1, T m^2 s^-1, eV, eV, J T m^2 s^-1, T m^3 s^-2, T m^3 s^-2, T m^2 s^-1, J T m^2 s^-1, m/s, T m s^-1, (T m)^2, T m^2 s^-1, J T m^2 s^-1, m^-3]
     - Flux-surface 1D delta-f diagnostic [species]_[channel]_df_1d on the psi/psi_mks grid; channel is one of [gc_density, gc_toroidal_flow, gc_poloidal_flow, parallel_flow, tor_angular_momentum, radial_flux, parallel_mean_en, perp_temperature, radial_en_flux, radial_mom_flux_ExB, radial_mom_flux, radial_flux_ExB, radial_en_flux_ExB, poloidal_ExB_flow, vpar_x_B, grad_psi_sqr, radial_flux_3db, radial_en_flux_3db, marker_density]. This group is evaluated with delta-f weights :math:`w_0 w_1` and is the relevant 1D moment diagnostic for delta-f species. For total-f species (f0_diag_on=True), contributions from the 5D phase-space mesh are added and, for density, temperature, and flow, analytical-background contributions are added as well. Radial fluxes are relative to the poloidal flux :math:`\psi` and should be divided by the flux-surface average :math:`\langle \|\nabla\psi\| \rangle`, or by the square root of [i,e]_grad_psi_sqr_1d, to convert to a radial flux per unit area. All quantities except density are normalized to the density/particle weight.

xgc.volumes.bp
--------------

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

   * - Variable
     - Units
     - Description
   * - ``diag_1d_npsi``
     - Positive integer
     - Number of psi surfaces
   * - ``diag_1d_vol``
     - m^3
     - Volume associated with each flux surface
   * - ``vol00``
     - m^3
     - Volume associated with each psi00 (evenly spaced in psi) surface