Skip to content

Add reservoirs to hydrology #148 #149

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

Draft
HEBaron wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add reservoirs to hydrology #148 #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ddb4ff9
Add reservoir variables
HEBaron Aug 26, 2026
839e74c
Adjustments to water resource code
HEBaron Aug 26, 2026
410fe2d
Include reservoir routing
HEBaron Aug 26, 2026
23dc657
fix to prevent indexing errors, and update to update- macro
HEBaron Aug 28, 2026
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
1 change: 1 addition & 0 deletions CONTRIBUTORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
| yaswant | Yaswant Pradhan | Met Office | 2026-06-30 |
| doucla | Douglas Clark | UKCEH | 2026-07-03 |
| james-bruten-mo | James Bruten | Met Office | 2026-07-09 |
| HEBaron | Helen Baron | UKCEH | 2026-08-26 |
48 changes: 44 additions & 4 deletions doc/source/namelists/ancillaries.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1093,7 +1093,7 @@ This namelist specifies the options available for initialising irrigated fractio

.. nml:namelist:: JULES_RIVERS_PROPS

This namelist specifies how spatially varying river routing properties including overbank inundation should be set.
This namelist specifies how spatially varying river routing properties (including overbank inundation and reservoirs) should be set.

.. note:: ``read_from_dump`` is not currently implemented for this namelist, meaning that river ancillary variables cannot be read from a dump file. Initial values of river prognostic variables can however be read from a dump file (see :nml:lst:`JULES_INITIAL`).

Expand Down Expand Up @@ -1455,14 +1455,14 @@ The following table summarises river routing properties required to run RFM or T
| ``longitude_2d`` | The longitude of each river grid point must be specified. This field is required only if the model |
| | coordinates are latitude and longitude, i.e. if :nml:mem:`JULES_LATLON::l_coord_latlon` = FALSE. |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``logn_mean`` | Mean of ln(elevation-elev_min) for each grid cell (in units ln(m)) |
| ``logn_mean`` | Mean of ln(elevation-elev_min) for each grid cell (in units ln(m)). |
| | |
| | This is only used if :nml:mem:`JULES_OVERBANK::overbank_model` = 3. |
| | |
| | Note that elev_min is DEM minimum, not river/lake bed level (therefore large values close to water |
| | bodies can occur in floodplain gridcells). |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``logn_stdev`` | Standard deviation of ln(elevation-elev_min) for each grid cell (in units ln(m)) |
| ``logn_stdev`` | Standard deviation of ln(elevation-elev_min) for each grid cell (in units ln(m)). |
| | |
| | This is only used if :nml:mem:`JULES_OVERBANK::overbank_model` = 3. |
| | |
Expand All @@ -1479,14 +1479,54 @@ The following table summarises river routing properties required to run RFM or T
| | 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. |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``rivers_storage`` | Water storage (kg) on the Rivers grid. |
| ``rivers_storage`` | Water storage (kg) on the rivers grid. |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::i_river_vn` = 3. |
| | |
| | This is only required if Rivers storage is to be initialised from an ancillary, including a 12-month |
| | climatology, rather than the dump. If Rivers storage is requested from an ancillary then |
| | ``rivers_sto_rp`` should not be requested via :nml:lst:`JULES_INITIAL`. |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_capacity_grid`` | Storage capacity of reservoirs (kg). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_catch_grid`` | Catchment area of reservoirs (m2). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_year_grid`` | Initialisation year of reservoirs. |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_critical_grid`` | Critical storage of reservoirs (kg). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_flood_grid`` | Flood storage of reservoirs (kg). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_emergency_grid`` | Emergency storage of reservoirs (kg). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_normal_release_grid``| Normal release rate of reservoirs (kg s-1). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+
| ``res_flood_release_grid`` | Flood release rate of reservoirs (kg s-1). |
| | |
| | This is only used if :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE. |
| | |
+----------------------------+-----------------------------------------------------------------------------------------------------------+


Example of how to set up the river grid
Expand Down
24 changes: 16 additions & 8 deletions doc/source/namelists/initial_conditions.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,18 +402,18 @@ The required variables for a particular configuration, along with their 'type' a
| Required if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::i_river_vn` = '2' and |
| :nml:mem:`JULES_INITIAL::dump_file` = TRUE |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rfm_surfstore_rp`` | Surface water storage on river routing points (m3) | none |
| ``rfm_surfstore_rp`` | Surface water storage on river routing points (m3). | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rfm_substore_rp`` | Sub-surface water storage on river routing points (m3) | none |
| ``rfm_substore_rp`` | Sub-surface water storage on river routing points (m3). | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rfm_flowin_rp`` | Surface flow into a grid box on river routing points (m3) | none |
| ``rfm_flowin_rp`` | Surface flow into a grid box on river routing points (m3). | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rfm_bflowin_rp`` | Sub-surface flow into a grid box on river routing points (m3) | none |
| ``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 |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``rivers_sto_rp`` | Water storage (kg) | none |
| ``rivers_sto_rp`` | Water storage (kg). | none |
| | | |
| | **Alternatively**, can be initialised from an ancillary file via | |
| | :nml:lst:`JULES_RIVERS_PROPS`. It cannot be requested via :nml:lst:`JULES_INITIAL` | |
Expand All @@ -423,7 +423,12 @@ The required variables for a particular configuration, along with their 'type' a
| :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 |
| ``rivers_outflow_rp`` | River outflow on river routing points (kg s\ :sup:`-1`). | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE and |
| :nml:mem:`JULES_INITIAL::dump_file` = TRUE |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``res_storage`` | Water stored in reservoirs, on river routing points (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` contains ``inland_outflow``. |
Expand All @@ -432,10 +437,9 @@ The required variables for a particular configuration, along with their 'type' a
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| Required if :nml:mem:`JULES_VEGETATION::photo_acclim_model` = 2 or 3 |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+
| ``t_growth_gb`` | Running mean air temperature (K) | none |
| ``t_growth_gb`` | Running mean air temperature (K). | none |
+----------------------------------+-----------------------------------------------------------------------------------------+---------+


.. warning::
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.
Expand All @@ -444,6 +448,10 @@ 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` = '1,3' and :nml:mem:`JULES_INITIAL::dump_file` = FALSE,
``rivers_sto_rp`` is initialised to zero **unless** it is initialised from an ancillary via :nml:lst:`JULES_RIVERS_PROPS`.

.. warning::
if :nml:mem:`JULES_RIVERS::l_rivers` = TRUE, :nml:mem:`JULES_RIVERS::l_reservoirs` = TRUE and :nml:mem:`JULES_INITIAL::dump_file` = FALSE,
``res_storage`` is initialised to zero.

.. |mu| unicode:: μ .. u


Expand Down
13 changes: 13 additions & 0 deletions doc/source/namelists/jules_rivers.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,19 @@ River routing introduces two more grids to a JULES run: the river routing input
``3``
Use a standalone JULES implementation of the TRIP model (see Oki et al. 1999).

.. nml:member:: l_reservoirs

:type: logical
:default: F

Switch for enabling routing through reservoirs. Only used if :nml:mem:`JULES_RIVERS::l_rivers` is TRUE.

TRUE
River flow is routed through reservoirs.

FALSE
No reservoirs are modelled.

.. nml:member:: l_riv_overbank

:type: logical
Expand Down
Loading
Loading