Update documentation for grid_outfile

CICE-Consortium · Jan 31, 2025 · 94eaf25 · 94eaf25
1 parent 9c77dac
commit 94eaf25
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/doc/source/cice_index.rst b/doc/source/cice_index.rst
@@ -303,6 +303,7 @@ section :ref:`tabnamelist`.
    "grid_ocn_dynu", "grid for ocn dynamic-u forcing/coupling fields, 'T', 'U', 'N', 'E'", ""
    "grid_ocn_dynv", "grid for ocn dynamic-v forcing/coupling fields, 'T', 'U', 'N', 'E'", ""
    "grid_ocn_thrm", "grid for ocn thermodynamic forcing/coupling fields, 'T', 'U', 'N', 'E'", ""
+   "grid_outfile", "write one-time grid history file", ""
    "grid_type", "‘rectangular’, ‘displaced_pole’, ‘column’ or ‘regional’", ""
    "gridcpl_file", "input file for coupling grid info", ""
    "grow_net", "specific biogeochemistry growth rate per grid cell", "s :math:`^{-1}`"

diff --git a/doc/source/user_guide/ug_case_settings.rst b/doc/source/user_guide/ug_case_settings.rst
@@ -313,6 +313,7 @@ grid_nml
    "", "``B``", "ocn forcing/coupling grid, thermo fields on T grid, dyn fields on U grid", ""
    "", "``C``", "ocn forcing/coupling grid, thermo fields on T grid, dynu fields on E grid, dynv fields on N grid", ""
    "", "``CD``", "ocn forcing/coupling grid, thermo fields on T grid, dyn fields on N and E grid", ""
+   "``grid_outfile``", "logical", "write one-time grid history file"``.false.``"
    "``grid_type``", "``displaced_pole``", "read from file in *popgrid*", "``rectangular``"
    "", "``rectangular``", "defined in *rectgrid*", ""
    "", "``regional``", "read from file in *popgrid*", ""

diff --git a/doc/source/user_guide/ug_implementation.rst b/doc/source/user_guide/ug_implementation.rst
@@ -1347,6 +1347,13 @@ directory in **iceh_ic.[timeID].nc(da)**. Several history variables are
 hard-coded for instantaneous output regardless of the ``hist_avg`` averaging flag, at
 the frequency given by their namelist flag.
 
+A one-time grid history file can be turned on with the ``grid_outfile`` namelist
+variable.  If ``grid_outfile`` is true, all the grid variables will be written
+to a history file once at the start of the run.  The grid data will only be written
+for blocks that have not been eliminated by the decomposition.  To generate a one-time
+grid history file without land block elimination, set ``distribution_wght = 'blockall'`` 
+and ``grid_outfile = .true.`` in the namelist.
+
 The normalized principal components of internal ice stress (``sig1``, ``sig2``) are computed
 in *principal_stress* and written to the history file. This calculation
 is not necessary for the simulation; principal stresses are merely