add docs for EOS

hklion · Dec 27, 2024 · 2992add · 2992add
1 parent 33d537e
commit 2992add
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/Docs/sphinx_doc/Inputs.rst b/Docs/sphinx_doc/Inputs.rst
@@ -508,6 +508,9 @@ List of Parameters
 | **remora.ggrav**                  | Gravitational field strength           | Real number       | 9.81           |
 |                                   | [kg m/s^2]                             |                   |                |
 +-----------------------------------+----------------------------------------+-------------------+----------------+
+| **remora.eos_type**               | Which equation of state to use.        | Linear or         | Linear         |
+|                                   | Nonlinear corresponds to UNESCO        | Nonlinear         |                |
++-----------------------------------+----------------------------------------+-------------------+----------------+
 | **remora.R0**                     | Background density [kg/m^3]            | Real number       | 1028           |
 |                                   | used in Linear Equation of             |                   |                |
 |                                   | State. May be used in setup            |                   |                |

diff --git a/Docs/sphinx_doc/Numerical_Solution_Technique.rst b/Docs/sphinx_doc/Numerical_Solution_Technique.rst
@@ -419,9 +419,19 @@ The integral is actually computed as a sum from the bottom upwards and also as a
 
 Equation of State
 -----------------
-The density is obtained from temperature :math:`\left(T\right)` and salinity :math:`\left(S\right)` via a linear equation of state:
+
+Linear Equation of State
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+When using the linear equation of state, density is obtained from temperature :math:`\left(T\right)` and salinity :math:`\left(S\right)` via a linear equation of state:
 
 .. math::
    \rho\left(T,S\right) = R_0 - R_0 T_{\mathrm{coef}} (T - T_0) + R_0 S_{\mathrm{coef}} (S-S_0).
 
 The constants :math:`R_0`, :math:`T_0`, :math:`S_0`, :math:`T_{\mathrm{coef}}`, and :math:`S_{\mathrm{coef}}` are specified in the :ref:`inputs`<list-of-parameters-15>` file.
+
+Nonlinear Equation of State
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The nonlinear equation of state option corresponds to the UNESCO equation of state as derived by Jackett and McDougall (1995), computing density as a fitted polynomial function of temperature, salinity, and pressure (for which depth is used as a proxy under the assumption that pressure does not change along geopotential surfaces).
+