Equilibrium and boundary
------------------------

.. No-Break Space
.. |nbsp| unicode:: 0xA0 
   :trim:

.. raw:: html

    <style> .red {color:red} </style>
      
.. role:: red

.. raw:: html

    <style> .smallbluegray {font-size:60%;color:rgb(102, 153, 204)} </style>
      
.. role:: smallbluegray

.. New line 
.. |br| raw:: html

  <br/>

There are four output files containing magnetic equilibrium and boundary parameters: xgc.bfield.bp, xgc.bfieldm.bp, xgc.bounce.bp and xgc.equil.bp.

For the name of the output variable, replace ``[species]`` with one of the following: ``e_``, ``i_``, ``i2``, ``i3``, ``i4``, ``i5``, ``i6``.

.. centered:: **xgc.bfield.bp** |br| :smallbluegray:`Printed when: ?` |nbsp| |nbsp| |nbsp| :smallbluegray:`Output frequency: once at start/restart.`

This file is for the magnetic field information at the node points of the 3D mesh.

.. list-table::
   :widths: 25 25 10 100
   :header-rows: 1

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *bfield*
     - | # |nbsp| planar |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 3
     - T
     - Magnetic field vector :math:`(B_R,B_Z,B_phi)` on the mesh nodes
   * - *n_n*
     - Scalar
     - 
     - Number of node points of the mesh
   * - *num_ntor*
     - Scalar
     - 
     - Number of toroidal mode numbers for RMP simulations (1+ptb_3db_num_ntor)
   * - *psi*
     - # |nbsp| planar |nbsp| mesh |nbsp| nodes
     - :math:`\mathrm{T m^2}`
     - Poloidal magnetic flux :math:`\psi` (over :math:`2 \pi`)

|br|
       
.. centered:: **xgc.bfieldm.bp** |br| :smallbluegray:`Printed when: ?` |nbsp| |nbsp| |nbsp| :smallbluegray:`Output frequency: once at start/restart.`

This file is for the magnetic field at the midplane. 

.. list-table::
   :widths: 25 25 10 100
   :header-rows: 1

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *N*
     - Scalar
     - 
     - # of midplane points (1000)
   * - *abs_bphi*
     - # of midplane points
     - T
     - Absolute value of toroidal magnetic field
   * - *dpdr*
     - # of midplane points
     - Tm
     - :math:`\frac{d\psi}{dr}`
   * - *psi_n*
     - # of midplane points
     - Normalized
     - Normalized poloidal magnetic flux by X-point value
   * - *rmajor*
     - # of midplane points
     - m
     - Major radius

|br|

.. centered:: **xgc.equil.bp** |br| :smallbluegray:`Printed when: ?` |nbsp| |nbsp| |nbsp| :smallbluegray:`Output frequency: once at start/restart.`
       
.. list-table::
   :widths: 25 25 10 100
   :header-rows: 1

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *eq_I*
     - eq_mpsi
     - Tm
     - :math:`B_{tor} R` as a function of flux label. Poloidal current function in EFIT
   * - *eq_axis_b*
     - Scalar
     - T
     - Magnetic field at the magnetic axis
   * - *eq_axis_r*
     - Scalar
     - m
     - Major radius at the magnetic axis
   * - *eq_axis_z*
     - Scalar
     - m
     - Z(height) at the magnetic axis
   * - *[species]eq_dens_path*
     - Scalar
     - 
     - A path constructed from input variables ``sml_input_file_dir`` and ``eq_dens_file``
   * - *eq_max_r*
     - Scalar
     - m
     - Maximum major radius of interpolation boundary
   * - *eq_max_z*
     - Scalar
     - m
     - Maximum height of interpolation boundary
   * - *eq_min_r*
     - Scalar
     - m
     - Minimum major radius of interpolation boundary
   * - *eq_min_z*
     - Scalar
     - m
     - Minimum height of interpolation boundary
   * - *eq_mpsi*
     - Scalar
     - 
     - Number of psi (poloidal flux/flux label) grid points 
   * - *eq_mr*
     - Scalar
     - 
     - Number of horizontal R grid points
   * - *eq_mz*
     - Scalar
     - 
     - Number of vertical Z grid points
   * - *eq_psi_grid*
     - eq_mpsi
     - :math:`Tm^2`
     - Poloidal flux on the :math:`\psi` grid points
   * - *eq_psi_rz*
     - | eq_mz
       | :math:`\times` |nbsp| eq_mr 
     - :math:`Tm^2`
     - Poloidal flux on the rectangular grid points
   * - *[species]eq_temp_path*
     - Scalar
     -  
     - A path constructed from input variables ``sml_input_file_dir`` and ``eq_temp_file``
   * - *eq_x_psi*
     - Scalar
     - :math:`Tm^2`
     - Description
   * - *eq_x_r*
     - Scalar
     - m
     - Major radius at the first (lower) X-point
   * - *eq_x_z*
     - Scalar
     - m
     - Height at the first (lower) X-point


.. toctree::
   :maxdepth: 1