Skip to content

Commit

Permalink
Merge pull request #121 from hklion/docs_updates
Browse files Browse the repository at this point in the history 
Docs updates
  • Loading branch information
@hklion
hklion authored Jan 9, 2024
2 parents 258c739 + 042b001 commit 398679d
Show file tree
Hide file tree
Showing 9 changed files with 163 additions and 162 deletions.
42 changes: 21 additions & 21 deletions Docs/sphinx_doc/Checkpoint.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,34 +22,34 @@ Writing the Checkpoint "Files"
List of Parameters
------------------

+---------------------------------+----------------+----------------+----------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+=================================+================+================+================+
+----------------------------------+----------------+----------------+----------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+==================================+================+================+================+
| **remora.check_file** | prefix for | String | “*chk*” |
| | restart files | | |
+---------------------------------+----------------+----------------+----------------+
| | restart files | | |
+----------------------------------+----------------+----------------+----------------+
| **remora.check_int** | how often (by | Integer | -1 |
| | level-0 time | :math:`> 0` | |
| | steps) to | | |
| | write restart | | |
| | files | | |
+---------------------------------+----------------+----------------+----------------+
| | level-0 time | :math:`> 0` | |
| | steps) to | | |
| | write restart | | |
| | files | | |
+----------------------------------+----------------+----------------+----------------+

Restarting
==========

+---------------------------------+----------------+----------------+----------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+=================================+================+================+================+
+----------------------------------+----------------+----------------+----------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+==================================+================+================+================+
| **remora.restart** | name of the | String | not used if |
| | file | | not set |
| | (directory) | | |
| | from which to | | |
| | restart | | |
| | files | | |
+---------------------------------+----------------+----------------+----------------+
| | file | | not set |
| | (directory) | | |
| | from which to | | |
| | restart | | |
| | files | | |
+----------------------------------+----------------+----------------+----------------+

.. _examples-of-usage-7:

Expand Down
106 changes: 53 additions & 53 deletions Docs/sphinx_doc/Inputs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,59 +477,59 @@ Physics Parameters
List of Parameters
------------------

+----------------------------------+----------------------------------+-------------------+---------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+==================================+==================================+===================+===============+
| **remora.ggrav** | Gravitational field strength | Real number | 9.81 |
| | [kg m/s^2] | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.R0** | Background density [kg/m^3] | Real number | 1028 |
| | used in Linear Equation of | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.S0** | Background salinity | Real number | 35 |
| | (nondimensional) used in | | |
| | Linear Equation of State | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.T0** | Background temperature | Real number | 5 |
| | (Celsius) used in | | |
| | Linear Equation of State | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.Tcoef** | Linear EOS parameter | Real number | 1.7e-4 |
| | (1/Celsius) | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.Scoef** | Linear EOS parameter | Real number | 0.0 |
| | (nondimensional) | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.rho0** | Mean density (kg/m^3) used | Real number | 1025 |
| | when Boussinesq approx is | | |
| | inferred | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.coriolis_type** | Type of Coriolis forcing. | `beta_plane` / | `beta_plane` |
| | beta_plane uses a linear | `custom` / | |
| | approximation. Custom is | `real | |
| | calculated from a function in | | |
| | prob.cpp, and Real is read from | | |
| | the netcdf grid file | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.coriolis_f0** | f-plane constant for | Real number | 0.0 |
| | Coriolis param | | |
| | :math:`f = f_0 + \beta y` | | |
| | when using beta plane | | |
| | Coriolis type | | |
+----------------------------------+----------------------------------+-------------------+---------------+
| **remora.coriolis_beta** | beta-plane constant for | Real number | 0.0 |
| | Coriolis param | | |
| | :math:`f = f_0 + \beta y` | | |
| | when using beta plane | | |
| | Coriolis type | | |
+----------------------------------+----------------------------------+-------------------+---------------+
+----------------------------------+--------------------------------------+-------------------+----------------+
| Parameter | Definition | Acceptable | Default |
| | | Values | |
+==================================+======================================+===================+================+
| **remora.ggrav** | Gravitational field strength | Real number | 9.81 |
| | [kg m/s^2] | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.R0** | Background density [kg/m^3] | Real number | 1028 |
| | used in Linear Equation of | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.S0** | Background salinity | Real number | 35 |
| | (nondimensional) used in | | |
| | Linear Equation of State | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.T0** | Background temperature | Real number | 5 |
| | (Celsius) used in | | |
| | Linear Equation of State | | |
| | State. May be used in setup | | |
| | of some problems. | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.Tcoef** | Linear EOS parameter | Real number | 1.7e-4 |
| | (1/Celsius) | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.Scoef** | Linear EOS parameter | Real number | 0.0 |
| | (nondimensional) | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.rho0** | Mean density (kg/m^3) used | Real number | 1025 |
| | when Boussinesq approx is | | |
| | inferred | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.coriolis_type** | Type of Coriolis forcing. | ``beta_plane`` / | ``beta_plane`` |
| | ``beta_plane`` uses a linear | ``custom`` / | |
| | approximation. ``custom`` is | ``real`` | |
| | calculated from a function in | | |
| | ``prob.cpp``, and ``real`` is | | |
| | read from the netcdf grid file | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.coriolis_f0** | f-plane constant for | Real number | 0.0 |
| | Coriolis param | | |
| | :math:`f = f_0 + \beta y` | | |
| | when using beta plane | | |
| | Coriolis type | | |
+----------------------------------+--------------------------------------+-------------------+----------------+
| **remora.coriolis_beta** | beta-plane constant for | Real number | 0.0 |
| | Coriolis param | | |
| | :math:`f = f_0 + \beta y` | | |
| | when using beta plane | | |
| | Coriolis type | | |
+----------------------------------+--------------------------------------+-------------------+----------------+

Numerical Algorithms
====================
Expand Down
Loading

0 comments on commit 398679d

Please sign in to comment.