Skip to content

Commit

Permalink
doc: correct Pstar units (#477)
Browse files Browse the repository at this point in the history
* doc: correct 'Pstar' units

'Pstar' was added to the namelist in c9cfebd (add Pstar and Cstar to
namelist (#475), 2020-06-26), but the wrong units were added to the
documentation (N/m instead of N/m^2). Also, it already appeared in the
index with the same wrong units.

Fix that.

While at it, fix the RST syntax for `k2`.

Reported-by: Jean-François Lemieux <jean-francois.lemieux@canada.ca>

* icepack: update to b1e41d9
  • Loading branch information
phil-blain authored Jul 3, 2020
1 parent ed78a99 commit fcf8989
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/source/cice_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ either Celsius or Kelvin units).
"print_points", ":math:`\bullet` if true, print point data", "F"
"processor_shape", ":math:`\bullet` descriptor for processor aspect ratio", ""
"prs_sig", "replacement pressure", "N/m"
"Pstar", "ice strength parameter", "2.75\ :math:`\times`\ 10\ :math:`^4`\ N/m"
"Pstar", "ice strength parameter", "2.75\ :math:`\times`\ 10\ :math:`^4`\ N/m\ :math:`^2`"
"puny", "a small positive number", "1\ :math:`\times`\ 10\ :math:`^{-11}`"
"**Q**", "", ""
"Qa", "specific humidity at 10 m", "kg/kg"
Expand Down
4 changes: 2 additions & 2 deletions doc/source/user_guide/ug_case_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -336,10 +336,10 @@ dynamics_nml
"", "``1``", "transport enabled", ""
"``Ktens``", "real", "Tensile strength factor (see :cite:`Konig10`)", "0.0"
"``k1``", "real", "1st free parameter for landfast parameterization", "8.0"
"``k2``", "real", "2nd free parameter (N/m^3) for landfast parameterization", "15.0"
"``k2``", "real", "2nd free parameter (N/m\ :math:`^3`) for landfast parameterization", "15.0"
"``mu_rdg``", "real", "e-folding scale of ridged ice for ``krdg_partic`` = 1 in m^0.5", "3.0"
"``ndte``", "integer", "number of EVP subcycles", "120"
"``Pstar``", "real", "constant in Hibler strength formula (N/m)", "2.75e4"
"``Pstar``", "real", "constant in Hibler strength formula (N/m\ :math:`^2`)", "2.75e4"
"``revised_evp``", "logical", "use revised EVP formulation", "``.false.``"
"``threshold_hw``", "real", "Max water depth for grounding (see :cite:`Amundrud04`)", "30."
"``yield_curve``", "``ellipse``", "elliptical yield curve", "``ellipse``"
Expand Down
2 changes: 1 addition & 1 deletion icepack
Submodule icepack updated 74 files
+0 −0 .github/PULL_REQUEST_TEMPLATE.md
+5 −3 README.md
+22 −0 columnphysics/icepack_flux.F90
+249 −40 columnphysics/icepack_shortwave.F90
+117 −32 columnphysics/icepack_therm_vertical.F90
+4 −0 configuration/driver/icedrv_arrays_column.F90
+13 −1 configuration/driver/icedrv_flux.F90
+12 −2 configuration/driver/icedrv_init_column.F90
+33 −9 configuration/driver/icedrv_step.F90
+2 −7 configuration/scripts/icepack.batch.csh
+5 −5 configuration/scripts/icepack.build
+1 −1 configuration/scripts/icepack.launch.csh
+1 −1 configuration/scripts/icepack.run.setup.csh
+3 −3 configuration/scripts/icepack.settings
+1 −1 configuration/scripts/icepack.test.setup.csh
+2 −2 configuration/scripts/machines/Macros.cheyenne_gnu
+2 −2 configuration/scripts/machines/Macros.conrad_gnu
+2 −2 configuration/scripts/machines/Macros.gaffney_gnu
+2 −2 configuration/scripts/machines/Macros.gordon_gnu
+2 −2 configuration/scripts/machines/Macros.izumi_gnu
+2 −2 configuration/scripts/machines/Macros.koehr_gnu
+0 −54 configuration/scripts/machines/Macros.loft_gnu
+2 −2 configuration/scripts/machines/Macros.onyx_gnu
+0 −47 configuration/scripts/machines/Macros.thunder_intel
+2 −2 configuration/scripts/machines/Macros.travisCI_gnu
+13 −2 configuration/scripts/machines/env.badger_intel
+35 −2 configuration/scripts/machines/env.cheyenne_gnu
+14 −3 configuration/scripts/machines/env.cheyenne_intel
+13 −2 configuration/scripts/machines/env.cheyenne_pgi
+4 −2 configuration/scripts/machines/env.conda_linux
+6 −4 configuration/scripts/machines/env.conda_macos
+13 −2 configuration/scripts/machines/env.conrad_cray
+34 −2 configuration/scripts/machines/env.conrad_gnu
+15 −4 configuration/scripts/machines/env.conrad_intel
+13 −2 configuration/scripts/machines/env.conrad_pgi
+13 −2 configuration/scripts/machines/env.cori_intel
+4 −2 configuration/scripts/machines/env.gaffney_gnu
+4 −2 configuration/scripts/machines/env.gaffney_intel
+4 −2 configuration/scripts/machines/env.gaffney_pgi
+13 −2 configuration/scripts/machines/env.gordon_cray
+13 −2 configuration/scripts/machines/env.gordon_gnu
+14 −3 configuration/scripts/machines/env.gordon_intel
+13 −2 configuration/scripts/machines/env.gordon_pgi
+2 −2 configuration/scripts/machines/env.high_Sierra_gnu
+14 −3 configuration/scripts/machines/env.hobart_intel
+11 −2 configuration/scripts/machines/env.hobart_nag
+13 −2 configuration/scripts/machines/env.izumi_gnu
+13 −2 configuration/scripts/machines/env.izumi_intel
+14 −2 configuration/scripts/machines/env.izumi_nag
+13 −2 configuration/scripts/machines/env.izumi_pgi
+4 −2 configuration/scripts/machines/env.koehr_gnu
+4 −2 configuration/scripts/machines/env.koehr_intel
+4 −2 configuration/scripts/machines/env.koehr_pgi
+0 −16 configuration/scripts/machines/env.loft_gnu
+13 −2 configuration/scripts/machines/env.onyx_cray
+13 −2 configuration/scripts/machines/env.onyx_gnu
+13 −2 configuration/scripts/machines/env.onyx_intel
+5 −3 configuration/scripts/machines/env.testmachine_intel
+0 −39 configuration/scripts/machines/env.thunder_intel
+4 −2 configuration/scripts/machines/env.travisCI_gnu
+1 −1 configuration/scripts/set_version_number.csh
+1 −1 configuration/scripts/setup_run_dirs.csh
+15 −0 configuration/scripts/tests/baseline.script
+20 −0 configuration/scripts/tests/icepack.codecov.csh
+47 −0 configuration/scripts/tests/icepack.lcov.csh
+54 −0 configuration/scripts/tests/icepack.results.csh
+23 −28 configuration/scripts/tests/poll_queue.csh
+17 −12 configuration/scripts/tests/report_results.csh
+6 −1 doc/source/icepack_index.rst
+1 −1 doc/source/science_guide/sg_mechanical.rst
+2 −2 doc/source/user_guide/ug_case_settings.rst
+46 −16 doc/source/user_guide/ug_running.rst
+29 −31 doc/source/user_guide/ug_testing.rst
+101 −113 icepack.setup

0 comments on commit fcf8989

Please sign in to comment.