From 1941db9585a57d22313fb76b19916cc2d7cbd2ac Mon Sep 17 00:00:00 2001 From: Jonathan Citrin Date: Wed, 12 Feb 2025 11:42:22 -0800 Subject: [PATCH] Updated user docs 1. Add newly generated post-processed output. 2. Correct error in description of geometry_type PiperOrigin-RevId: 726136637 --- docs/configuration.rst | 4 ++-- docs/output.rst | 24 ++++++++++++++++++++++++ 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index c8b8742f..6b171aa8 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -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. diff --git a/docs/output.rst b/docs/output.rst index c5d679a8..9f388dc0 100644 --- a/docs/output.rst +++ b/docs/output.rst @@ -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. @@ -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