2D Diagnostics
==============

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

Two-dimensional diagnostic outputs. Some call sites also write the corresponding 3D file in non-XGCa runs.

xgc.2d/3d.*.bp
--------------

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

   * - Variable
     - Units
     - Description
   * - ``As_rho_ff``
     - T m
     - Field-following As components at gyrocenter
   * - ``aparh``
     - T m
     - Perturbed parallel vector potential A_h
   * - ``apars``
     - T m
     - Perturbed scalar potential components As
   * - ``dAs_rho_ff``
     - T m
     - Field-following derivatives of As at gyrocenter
   * - ``dBphi``
     - T
     - Toroidal magnetic field perturbation in Tesla
   * - ``dBpsi``
     - T
     - Radial magnetic field perturbation in Tesla
   * - ``dBtheta``
     - T
     - Poloidal magnetic field perturbation in Tesla
   * - ``ddpotdt``
     - V s^-1
     - Time derivative of perturbed potential
   * - ``depsidt``
     - V m^-1 s^-1
     - Time derivative of electric field across flux surfaces
   * - ``dethetadt``
     - V m^-1 s^-1
     - Time derivative of electric field along flux surfaces
   * - ``dpot``
     - V
     - Perturbed potential in volt.
   * - ``dpot_es``
     - V
     - Electrostatic potential
   * - ``dpot_n0``
     - V
     - n=0 component of perturbed potential
   * - ``eden``
     - m^-3
     - Electron density at each mesh node interpolated from surrounding marker particles
   * - ``ejpar``
     - A m^-2
     - Electron parallel current density
   * - ``epara``
     - V/m
     - Parallel (to the magnetic field) electric field
   * - ``epara2``
     - V/m
     - Parallel electric field for evaluating :math:`\partial A_s/\partial t = -\mathbf{b}\cdot\nabla\phi`
   * - ``epsi``
     - V/m
     - Radial electric field in Volt per meter
   * - ``etheta``
     - V/m
     - Poloidal electric field in Volt per meter
   * - ``gstep``
     - Non-negative integer
     - XGC global simulation time step for this output slice.
   * - ``iden``
     - m^-3
     - Ion density at each mesh node interpolated from surrounding marker particles
   * - ``ijpar``
     - A m^-2
     - Ion parallel current density
   * - ``iphi``
     - Positive integer
     - Index of local plane (0-based)
   * - ``nnode``
     - Positive integer
     - Number of 3D mesh nodes.
   * - ``node_to_wall``
     - Integer index
     - Mapping from mesh node to wall index
   * - ``nphi``
     - Positive integer
     - Number of toroidal mesh planes :math:`N_{\mathrm{planes}}`.
   * - ``nwall``
     - Positive integer
     - Number of wall vertices
   * - ``phi``
     - rad
     - Toroidal angle of this plane
   * - ``phi_left``
     - rad
     - Toroidal angle of left plane
   * - ``phi_right``
     - rad
     - Toroidal angle of right plane
   * - ``pot0``
     - V
     - Axisymmetric, flux-surface averaged (n=0, m=0) electric potential
   * - ``pot0m``
     - V
     - Axisymmetric (n=0, m>0) electric potential
   * - ``sheath_nphi``
     - Positive integer
     - Number of unique planes of sheath potential
   * - ``shpot``
     - V
     - Sheath potential
   * - ``sp_name + "marker_den"``
     - # marker particles
     - Marker density at each mesh node interpolated from surrounding marker particles
   * - ``sp_name + "mean_weight"``
     - #real / #marker
     - Mean particle weight (real particles / marker particles) at each mesh node
   * - ``sp_name + "temp"``
     - eV
     - Temperature moment
   * - ``sp_name + "vp"``
     - m/s
     - Parallel velocity moment
   * - ``sp_name + "weight_variance"``
     - (#real)^2 / #marker
     - Particle weight variance at each mesh node
   * - ``sp_name + "wsum"``
     - m^-3
     - Density moment
   * - ``time``
     - s
     - Simulation time of step in seconds
   * - ``tindex``
     - Positive integer
     - Index of this field diagnostic output time slice. Values: 1, 2, ..., # outputs.

xgc.f2d/f3d.*.bp
----------------

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

   * - Variable
     - Units
     - Description
   * - ``[species]_T_perp``
     - eV
     - Perpendicular temperature for each non-adiabatic species.
   * - ``[species]_T_para``
     - eV
     - Parallel temperature for each non-adiabatic species.
   * - ``[species]_u_para``
     - m/s
     - Parallel bulk flow for each non-adiabatic species.
   * - ``[species]_den``
     - m^-3
     - Density for each non-adiabatic species.
   * - ``[species]_[channel]_[component]_[contribution]``
     - channel-dependent
     - Velocity-space moment for each non-adiabatic species. [channel] is one of toroidal_flow, poloidal_flow, parallel_flow, radial_flux_ExB, radial_flux_mag, radial_flux_3db, tor_ang_mom, rad_mom_flux_ExB, rad_mom_flux_mag, rad_mom_flux_3db, radial_en_flux_ExB, radial_en_flux_mag, radial_en_flux_3db, radial_pot_en_flux_ExB, radial_pot_en_flux_mag, radial_pot_en_flux_3db, par_mom_flux, par_en_flux, or par_pot_en_flux. [component] is n0 or turb in XGC1 and omitted in XGCa. [contribution] is f0 for the adiabatic contribution or df for the non-adiabatic contribution.
   * - ``[species]_den_en``
     - m^-3
     - Energy-binned density for XGC1 turbulent non-adiabatic moments.
   * - ``[species]_energy_en``
     - eV
     - Energy-bin coordinate for XGC1 turbulent non-adiabatic moments.
   * - ``[species]_ExB_flux_en``
     - m^-2 s^-1
     - Energy-binned ExB particle flux for XGC1 turbulent non-adiabatic moments.
   * - ``[species]_ExB_enflux_en``
     - J m^-2 s^-1
     - Energy-binned ExB energy flux for XGC1 turbulent non-adiabatic moments.
   * - ``[species]_f0_delta_n``
     - m^-3
     - Species density perturbation added to the analytic f0 background.
   * - ``[species]_f0_delta_u``
     - m/s
     - Species flow perturbation added to the analytic f0 background.
   * - ``[species]_f0_delta_T``
     - eV
     - Species temperature perturbation added to the analytic f0 background.
   * - ``dpot``
     - V
     - Perturbed potential at the midplane, written by XGC1.
   * - ``pot0``
     - V
     - Axisymmetric potential, written by XGC1.