Skip to content

Inland flow #79

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
DanCopsey wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Inland flow #79

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
4aabf96
Add new switches
DanCopsey Sep 10, 2025
f3239ae
Add send_fields info and links
DanCopsey Sep 10, 2025
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
14 changes: 14 additions & 0 deletions user_guide/doc/source/namelists/jules_hydrology.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ This file sets the hydrology options. It contains one namelist called :nml:lst:`
.. note::
Setting :nml:mem:`JULES_HYDROLOGY::l_top` = FALSE and :nml:mem:`JULES_HYDROLOGY::l_pdm` = FALSE selects a more basic runoff production scheme. In this scheme, surface runoff comes only from infiltration excess runoff (no saturation excess runoff), and subsurface runoff comes only from free drainage from the deepest soil layer (no lateral flow from mid-layers), as described in Essery et al. (2001, HCTN 30).


.. nml:member:: l_limit_gsoil

:type: logical
Expand All @@ -99,6 +100,19 @@ This file sets the hydrology options. It contains one namelist called :nml:lst:`
Allow the soil conductance to increase as the top layer soil moisture goes above the critical soil moisture, as in Best et al. (2011) equation 7.


.. nml:member:: l_inland

:type: logical
:default: F

TRUE
Some rivers end at inland basin flow points. This inland basin flow is used to increase soil moisture at these locations. For this to work JULES rivers_standalone needs
to be run as a separate executable and the inland basin flow needs to be passed into this land surface component via OASIS using :nml:mem:`OASIS_RIVERS::send_fields`.

Copy link
Collaborator

@maggiehendry maggiehendry Sep 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested rewording as it has to be relevant for the UM.
Some rivers end at inland basin flow points. This inland basin flow is used to increase soil moisture at these locations for water conservation purposes. This is only available for coupled models i.e. UM or LFRic. When coupled to LFRic, the soil moisture flux correction applied by this switch must be calculated by the Rivers-standalone component (:nml:mem:JULES_MODEL_ENVIRONMENT::lsm_id = 3) and passed to LFRic via OASIS using :nml:mem:OASIS_RIVERS::send_fields = inland_outflow.

FALSE
No inland basin flow.


Copy link
Collaborator

@maggiehendry maggiehendry Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should highlight that this is only used in coupled models e.g.
.. note::
Inland basin flow is only available to coupled models i.e. UM & LFRic via OASIS-Rivers.

.. nml:group:: Only used if :nml:mem:`JULES_HYDROLOGY::l_top` = TRUE

.. nml:member:: zw_max
Expand Down
14 changes: 13 additions & 1 deletion user_guide/doc/source/namelists/model_grid.nml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ Examples of how to specify the model domain using through this namelist are prov

.. nml:namelist:: JULES_LAND_FRAC

Land fraction is the fraction of each gridbox that is land. Currently, JULES considers any gridbox with land fraction > 0 to be 100% land, and all others to be 100% sea (or sea-ice). Land fraction data can be used to select only land points from the full input grid (see below).
Land fraction is the fraction of each gridbox that is land. By default, JULES considers any gridbox with land fraction > 0 to be 100% land, and all others to be 100% sea (or sea-ice). To keep land fractions as fractions then set l_use_land_fraction to True. Land fraction data can be used to select only land points from the full input grid (see below).
Copy link
Collaborator

@maggiehendry maggiehendry Sep 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Land fractions are only used by TRIP in Rivers-standalone to determine coastal endorheic basins. So the docs should reflect this. How about:

Land fraction is the fraction of each gridbox that is land. By default, JULES considers any gridbox with land fraction > 0 to be 100% land, and all others to be 100% sea (or sea-ice). Rivers-standalone (TRIP) when coupled to LFRic needs to be able to determine coastal endorheic basins. In this case, :nml:mem:l_use_land_fraction, allows the land fractions to be kept. Land fraction data can be used to select only land points from the full input grid (see below).


.. warning::
When the input grid consists of a single location (1D and :nml:mem:`JULES_INPUT_GRID::npoints` = 1 or 2D and :nml:mem:`JULES_INPUT_GRID::nx` = :nml:mem:`JULES_INPUT_GRID::ny` = 1), that single location is assumed to be 100% land.
Expand Down Expand Up @@ -412,6 +412,18 @@ For any input grid with more than a single location, the following are used:
In the file, the variable must have no levels dimensions and no time dimension.


.. nml:member:: l_use_land_fraction

:type: logical
:default: F

Copy link
Collaborator

@maggiehendry maggiehendry Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently there is no link between l_inland and l_use_land_fraction in the code as they are done in two steps. l_inland cannot be used unless coupled, however this is a standalone namelist so it is a bit confusing I think. How about first having an explanation of when the switch is used.

Land fractions are used to determine coastal endorheic basins to calculate the inland basin flow diagnostic inland_outflow_rp or :nml:mem:OASIS_RIVERS::send_fields = inland_outflow.

TRUE
Supply land fractions (as fractions) to both the main grid and the rivers grid (if grids are compatible). This is needed for water conservation when using inland basin flow (l_inland = True).
Copy link
Collaborator

@maggiehendry maggiehendry Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Supply land fractions (as fractions) to both the main grid and the rivers grid. This requires both grids and land-sea mask to be the same.


FALSE
Land fractions are not used and the land fraction field is set to either 1.0 (any land) or 0.0.


Copy link
Collaborator

@maggiehendry maggiehendry Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.. note:: This is only available in Rivers-standalone (TRIP) to calculate inland outflow fields.


``JULES_MODEL_GRID`` namelist members
-------------------------------------
Expand Down
8 changes: 6 additions & 2 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 @@ -40,12 +40,16 @@ This file contains a single namelists called :nml:lst:`OASIS_RIVERS`, which indi
.. nml:member:: send_fields

:type: character(:)
:permitted: 'outflow_per_river'
:permitted: 'outflow_per_river','inland_outflow'
: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 (`outflow_per_river`).
.. note:: The fields that can be sent via coupling are:

1. The total river runoff (`outflow_per_river`) which is sent to the ocean.

2. The inland basin flow (`inland_outflow`) which is sent to the land surface hydrology scheme. Turn on :nml:mem:`JULES_HYDROLOGY::l_inland` (in the land surface side of the coupler) to pass this inland basin flow into soil moisture.

.. nml:member:: receive_fields

Expand Down