Skip to content

Commit

Permalink
Clarify documentation associated with namelist inputs (#470)
Browse files Browse the repository at this point in the history
* Clarify documentation associated with namelist inputs

Alphabetize cpl_frazil namelist documentation

* Update documentation
  • Loading branch information
apcraig authored Oct 18, 2023
1 parent 863b19c commit 7a0d4e9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
8 changes: 5 additions & 3 deletions doc/source/icepack_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
Index of primary variables and parameters
==========================================

This index defines many of the symbols used frequently in the ice model
This index defines many (but not all) of the symbols used frequently in the ice model
code. Values appearing in this list are fixed or recommended; most
namelist parameters are indicated ( :math:`\bullet`) with their default
values. For other namelist options, see Section :ref:`tabnamelist`. All
quantities in the code are expressed in MKS units (temperatures may take
values. All quantities in the code are expressed in MKS units (temperatures may take
either Celsius or Kelvin units). Deprecated parameters are listed at the end.

Namelist variables are partly included here, but they are fully documented in
section :ref:`tabnamelist`.

.. csv-table:: *Alphabetical Index of Icepack Variables and Parameters*
:header: " ", " ", " "
:widths: 15, 30, 15, 1
Expand Down
14 changes: 7 additions & 7 deletions doc/source/user_guide/ug_case_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. _case_settings:

Case Settings
=====================
Case Settings, Model Namelist, and CPPs
====================================================

There are two important files that define the case, **icepack.settings** and
**icepack_in**. **icepack.settings** is a list of env variables that define many
Expand Down Expand Up @@ -115,8 +115,8 @@ can be modified as needed.

.. _tabnamelist:

Table of Namelist Inputs
--------------------------
Tables of Namelist Options
----------------------------

The Icepack driver reads a namelist input file, **icepack_in**, consisting of several namelist groups. The tables below
summarize the different groups and the variables in each group. The variables are organized alphabetically
Expand Down Expand Up @@ -344,6 +344,9 @@ forcing_nml
"``calc_strair``", "``.false.``", "read wind stress and speed from files", "``.true.``"
"", "``.true.``", "calculate wind stress and speed", ""
"``calc_Tsfc``", "logical", "calculate surface temperature", "``.true.``"
"``cpl_frazil``", "``external``", "frazil water/salt fluxes are handled outside of Icepack", "``fresh_ice_correction``"
"", "``fresh_ice_correction``", "correct fresh-ice frazil water/salt fluxes for mushy physics", ""
"", "``internal``", "send full frazil water/salt fluxes for mushy physics", ""
"``data_dir``", "string", "path to forcing data directory", "' '"
"``default_season``", "``summer``", "forcing initial summer values", "``winter``"
"", "``winter``", "forcing initial winter values", ""
Expand Down Expand Up @@ -378,9 +381,6 @@ forcing_nml
"", "``minus1p8``", "constant ocean freezing temperature (:math:`-1.8^{\circ} C`)", ""
"", "``mushy``", "matches mushy-layer thermo (ktherm=2)", ""
"``trestore``", "integer", "sst restoring time scale (days)", "90"
"``cpl_frazil``", "``external``", "frazil water/salt fluxes are handled outside of Icepack", "``fresh_ice_correction``"
"", "``fresh_ice_correction``", "correct fresh-ice frazil water/salt fluxes for mushy physics", ""
"", "``internal``", "send full frazil water/salt fluxes for mushy physics", ""
"``update_ocn_f``", "``.false.``", "do not include frazil water/salt fluxes in ocn fluxes", "``.false.``"
"", "``true``", "include frazil water/salt fluxes in ocn fluxes", ""
"``ustar_min``", "real", "minimum value of ocean friction velocity in m/s", "0.005"
Expand Down

0 comments on commit 7a0d4e9

Please sign in to comment.