Skip to content

Commit

Permalink
doc: correct description of box2001 test (#510)
Browse files Browse the repository at this point in the history
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.

While at it, add the correct unit for the Coriolis parameter (in both places
where it appears in the documentation).

Closes #509

Reported-by: Jean-François Lemieux <jean-francois.lemieux@canada.ca>
  • Loading branch information
phil-blain authored Aug 26, 2020
1 parent 164fcfc commit 40533df
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/source/user_guide/ug_case_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/ug_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 40533df

Please sign in to comment.