Skip to content

Commit

Permalink
Updated user docs
Browse files Browse the repository at this point in the history
1. Add newly generated post-processed output.
2. Correct error in description of geometry_type

PiperOrigin-RevId: 726136637
  • Loading branch information
jcitrin authored and Torax team committed Feb 13, 2025
1 parent af447f2 commit 1941db9
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -517,8 +517,8 @@ total pressure at the pedestal and the ratio of ion to electron temperature.
geometry
--------

``geometry_type`` (str = 'chease')
Geometry model used, from the following options.
``geometry_type`` (str)
Geometry model used. A string must be provided from the following options.

* ``'circular'``
An ad-hoc circular geometry model. Includes elongation corrections.
Expand Down
24 changes: 24 additions & 0 deletions docs/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,21 @@ analysis and inspection.
``pressure_thermal_tot_face`` (time, rho_face) [Pa]:
Total thermal pressure on the face grid.

``te_volume_avg`` (time) [keV]:
Volume average electron temperature.

``ti_volume_avg`` (time) [keV]:
Volume average ion temperature.

``ne_volume_avg`` (time) [nref m^-3]:
Volume average electron density.

``ni_volume_avg`` (time) [nref m^-3]:
Volume average ion density.

``fgw_ne_volume_avg`` (time) [dimensionless]:
Greenwald fraction from volume-averaged electron density.

``pprime_face`` (time, rho_face) [Pa/Wb]:
Derivative of total pressure with respect to poloidal flux on the face grid.

Expand All @@ -228,6 +243,15 @@ analysis and inspection.
``W_thermal_tot`` (time) [J]:
Total thermal stored energy.

``Wpol`` (time) [J]
Total magnetic energy

``q95`` (time) [dimensionless]
Safety-factor at 95% of the normalized poloidal flux coordinate.

``li3`` (time) [dimensionless]:
Normalized plasma internal inductance, ITER convention

``tauE`` (time) [s]:
Thermal confinement time defined as ``W_thermal_tot`` / ``P_heating``, where
``P_heating`` is the total heating power into the plasma, including external
Expand Down

0 comments on commit 1941db9

Please sign in to comment.