Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New restart dump functionality documentation change #33

Merged
merged 2 commits into from
Feb 15, 2024
Merged

New restart dump functionality documentation change #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ef506c
#32: updating docs to reflect change in trac ticket #1361
lianneparkhouse Jan 9, 2024
7ad9560
Merge branch 'master' into 32_restart_dump_docs_change
lianneparkhouse Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion user_guide/doc/source/namelists/ancillaries.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1140,7 +1140,7 @@ This namelist specifies how spatially varying river routing properties should be
.. nml:member:: rivers_regrid

:type: logical
:default: T
:default: F

Flag indicating if variables on the land grid need to be regridded (interpolated) to the river routing grid. This is currently only possible for grids that are regular in latitude and longituide. We distinguish between regridding (which is used between land and river grids of different resolution, or the same resolution but staggered relative to one another) and remapping (between consistent grids of the same resolution).

Expand Down Expand Up @@ -1272,6 +1272,16 @@ Grids are considered consistent (and therefore regridding is not required) if th
This is not used for variables where :nml:mem:`use_file` = TRUE, but a placeholder must still be given in that case.


.. nml:group:: Additional ancillaries, which may be required depending on requested options

.. nml:member:: riv_number_file

:type: character
:default: ''

Ancillary file containing river numbers, which assign each river mouth on the Rivers grid, to the river which discharges into it. The river number is used in the calculation of 'outflow_per_river' (River outflow into the ocean for each river; kg s\ :sup:`-1`), when it is requested either as a JULES output (:nml:mem:`JULES_OUTPUT_PROFILE::var`) or as a send field when coupled to OASIS (:nml:mem:`OASIS_RIVERS::send_fields`). The river outflow for each river is calculated as the sum of the river outflows corresponding to that river. When passed to the ocean model via OASIS the river outflow is distributed over the corresponding river outflow points on the ocean grid. This is to ensure that water is conserved and rivers discharge into the correct ocean grid points.


.. _list-of-rivers-params:

List of rivers properties
Expand Down
2 changes: 1 addition & 1 deletion user_guide/doc/source/namelists/contents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ These files have specific names, and JULES expects all these files to exist for
jules_deposition.nml
jules_snow.nml
jules_rivers.nml
oasis_rivers.nml
jules_water_resources.nml
jules_irrig.nml
science_fixes.nml
Expand All @@ -52,4 +53,3 @@ These files have specific names, and JULES expects all these files to exist for
prescribed_data.nml
initial_conditions.nml
output.nml
oasis_rivers.nml
24 changes: 15 additions & 9 deletions user_guide/doc/source/namelists/initial_conditions.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The values of all prognostic variables must be set at the start of a run. This i
.. nml:group:: Members used to set up spatially varying properties

.. nml:member:: file

:type: character
:default: None

Expand All @@ -54,7 +54,7 @@ The values of all prognostic variables must be set at the start of a run. This i

If :nml:mem:`dump_file` = TRUE, this should be a JULES dump file.

If :nml:mem:`dump_file` = FALSE, this should be a file conforming to the :doc:`JULES input requirements </input/overview>`. This file name may use :doc:`variable name templating </input/file-name-templating>`.
If :nml:mem:`dump_file` = FALSE, this should be a file conforming to the :doc:`JULES input requirements </input/overview>`. This file name may use :doc:`variable name templating </input/file-name-templating>`.


.. nml:member:: nvars
Expand Down Expand Up @@ -271,17 +271,17 @@ The required variables for a particular configuration, along with their 'type' a
| ``sthu_irr`` | Unfrozen soil wetness of each layer as a fraction of saturation in irrigated fraction. | soil |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_SURFACE_TYPES::ncpft` > 0 |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``cropdvi`` | Development index for each crop pft. | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``croprootc`` | Root carbon pool for each crop pft (kg m\ :sup:`-2`). | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``cropharvc`` | Carbon in 'harvest parts' pool for each crop pft (kg m\ :sup:`-2`) . | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``cropreservec`` | Carbon in stem reserves pool for each crop pft (kg m\ :sup:`-2`). | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``croplai`` | Leaf area index of each crop pft. | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``cropcanht`` | Height (m) of each crop pft. | cpft |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_HYDROLOGY::l_top` = TRUE |
Expand All @@ -294,7 +294,7 @@ The required variables for a particular configuration, along with their 'type' a
| ``zw`` | Depth from the surface to the water table (m). | None |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_SOIL::l_bedrock` = TRUE |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``tsoil_deep`` | Temperature of each bedrock layer (K) | bedrock |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_RADIATION::l_snow_albedo` = TRUE |
Expand Down Expand Up @@ -412,10 +412,16 @@ The required variables for a particular configuration, along with their 'type' a
| ``rfm_bflowin_rp`` | Sub-surface flow into a grid box on river routing points (m3) | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::i_river_vn` = '1,3' and |
| :nml:mem:`JULES_INITIAL::dump_file` = TRUE |
| :nml:mem:`JULES_INITIAL::dump_file` = TRUE |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rivers_sto_rp`` | Water storage (kg) | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::i_river_vn` = '3', |
| :nml:mem:`JULES_INITIAL::dump_file` = TRUE and :nml:mem:`OASIS_RIVERS::send_fields` or |
| :nml:mem:`JULES_OUTPUT_PROFILE::var` contains 'outflow_per_river' |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rivers_outflow_rp`` | River outflow on river routing points (kg s\ :sup:`-1`) | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_VEGETATION::photo_acclim_model` = 2 or 3 |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``t_growth_gb`` | Running mean air temperature (K) | none |
Expand All @@ -426,7 +432,7 @@ The required variables for a particular configuration, along with their 'type' a
if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::i_river_vn` = '2' and :nml:mem:`JULES_INITIAL::dump_file` = FALSE,
rfm_surfstore_rp, rfm_substore_rp, rfm_flowin_rp and rfm_bflowin are initialised to zero.

.. warning::
.. warning::
if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::i_river_vn` = '1,3' and :nml:mem:`JULES_INITIAL::dump_file` = FALSE,
rivers_sto_rp is initialised to zero.

Expand Down
8 changes: 4 additions & 4 deletions user_guide/doc/source/namelists/oasis_rivers.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ This file contains a single namelists called :nml:lst:`OASIS_RIVERS`, which indi
:permitted: 2
:default: imdi

The number of fields that are received from other models via OASIS coupling.
The number of fields that are received from other models via OASIS coupling.

.. nml:member:: np_send

:type: integer
:permitted: 0,1
:default: imdi

The number of fields that are sent to other models via OASIS coupling.
The number of fields that are sent to other models via OASIS coupling.

.. nml:member:: cpl_freq

Expand All @@ -40,12 +40,12 @@ This file contains a single namelists called :nml:lst:`OASIS_RIVERS`, which indi
.. nml:member:: send_fields

:type: character(:)
:permitted: 'rflow_outflow'
:permitted: 'outflow_per_river'
:default: ''

List of fields to be sent via coupling from the river executable to other models. Names are case sensitive

.. note:: The only field that can be sent via coupling is the total river runoff (`rflow_outflow`).
.. note:: The only field that can be sent via coupling is the total river runoff (`outflow_per_river`).

.. nml:member:: receive_fields

Expand Down
9 changes: 9 additions & 0 deletions user_guide/doc/source/output-variables.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,15 @@ Rivers
| ``rflow_rp`` | River routing gridbox river flow rate (kg m\ :sup:`-2` s\ :sup:`-1`). | np_rivers |
| | Only available if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE. | |
+-------------------------------+-----------------------------------------------------------------------------------------------+------------+
| ``rivers_outflow_rp`` | River outflow on river routing grid (kg s\ :sup:`-1`). | np_rivers |
| | Only available if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE. | |
+-------------------------------+-----------------------------------------------------------------------------------------------+------------+
| ``outflow_per_river`` | River outflow into the ocean for each river (kg s\ :sup:`-1`). | np_rivers |
| | Only available if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE. | |
| | | |
| | This technically has dimensions of "np_rivers", although only ``[1:n_rivers]``, defined by | |
| | the :nml:mem:`JULES_RIVERS_PROPS::riv_number_file`, is populated. | |
+-------------------------------+-----------------------------------------------------------------------------------------------+------------+
| ``rrun_rp`` | River routing gridbox runoff rate received by river routing routine | np_rivers |
| | (kg m\ :sup:`-2` s\ :sup:`-1`). | |
| | Only available if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE. | |
Expand Down