doc: correct description of box2001 test

The documentation states that this test case sets 'coriolis' to zero, but 'configuration/scripts/options/set_nml.box2001' sets 'coriolis' to 'constant'. Fix the documentation to be in line with the code. Closes #509 Reported-by: Jean-François Lemieux <[email protected]>
CICE-Consortium · Aug 25, 2020 · 55e2b3d · 55e2b3d
1 parent e5ff1f2
commit 55e2b3d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst
@@ -364,7 +364,7 @@ dynamics_nml
    "``brlx``", "real", "revised_evp value", "300.0"
    "``basalstress``", "logical", "use basal stress parameterization for landfast ice", "``.false.``"
    "``Cf``", "real", "ratio of ridging work to PE change in ridging", "17.0"
-   "``coriolis``", "``constant``", "constant coriolis value = 1.46e-4", "``latitude``"
+   "``coriolis``", "``constant``", "constant coriolis value = 1.46e-4 s\ :math:`^{-1}`", "``latitude``"
    "", "``latitude``", "coriolis variable by latitude", ""
    "", "``zero``", "zero coriolis", ""
    "``Cstar``", "real", "constant in Hibler strength formula", "20"

diff --git a/doc/source/user_guide/ug_testing.rst b/doc/source/user_guide/ug_testing.rst
@@ -228,7 +228,7 @@ boundary around the entire domain.  It includes the following namelist modificat
 - ``dxrect``: ``16.e5`` cm
 - ``dyrect``: ``16.e5`` cm
 - ``ktherm``: ``-1`` (disables thermodynamics)
-- ``coriolis``: ``zero`` (zero coriolis force)
+- ``coriolis``: ``constant`` (``f=1.46e-4`` s\ :math:`^{-1}`)
 - ``ice_data_type`` : ``box2001`` (special ice concentration initialization)
 - ``atm_data_type`` : ``box2001`` (special atmospheric and ocean forcing)