Matrix operations
-----------------

.. 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 matrix operations variables in
sparse matrix format: xgc.ff_fourier.bp, xgc.fluxavg.bp, xgc.grad_rz.bp and xgc.smooth_pol.bp.

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

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

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *eindex*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 1
     - Units
     - Description
   * - *nelement*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *nnode*
     - Scalar
     - Positive integer
     - Number of 3D mesh nodes.
   * - *npsi*
     - Scalar
     - Positive integer
     - Number of flux surfaces.
   * - *value*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 1
     - Units
     - Description
   * - *width*
     - Scalar
     - Units
     - Description

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

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

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *eindex*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 2
     - Units
     - Description
   * - *eindex2*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 5
     - Units
     - Description
   * - *nelement*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *nelement2*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *nnode*
     - Scalar
     - Positive integer
     - Number of 3D mesh nodes.
   * - *norm1d*
     - # |nbsp| flux |nbsp| surfaces
     - Units
     - Description
   * - *norm2d*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *npsi*
     - Scalar
     - Positive integer
     - Number of flux surfaces.
   * - *value*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 2
     - Units
     - Description
   * - *value2*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| 5
     - Units
     - Description
   * - *width*
     - Scalar
     - Units
     - Description
   * - *width2*
     - Scalar
     - Units
     - Description

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

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

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *basis*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *eindex_r*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *eindex_z*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *m_r*
     - Scalar
     - Units
     - Description
   * - *m_z*
     - Scalar
     - Units
     - Description
   * - *n_r*
     - Scalar
     - Units
     - Description
   * - *n_z*
     - Scalar
     - Units
     - Description
   * - *nelement_r*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *nelement_z*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *value_r*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *value_z*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *w_r*
     - Scalar
     - Units
     - Description
   * - *w_z*
     - Scalar
     - Units
     - Description

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

   * - *Output*
     - Dimension
     - Units
     - Description
   * - *eindex*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *m*
     - Scalar
     - Units
     - Description
   * - *n*
     - Scalar
     - Units
     - Description
   * - *nelement*
     - # |nbsp| 3D |nbsp| mesh |nbsp| nodes
     - Units
     - Description
   * - *value*
     - | # |nbsp| 3D |nbsp| mesh |nbsp| nodes
       | :math:`\times` |nbsp| ?
     - Units
     - Description
   * - *w*
     - Scalar
     - Units
     - Description

.. toctree::
   :maxdepth: 1