6.16. oasis_rivers.nml
¶
This file contains a single namelists called OASIS_RIVERS
, which indicates how the Rivers-only executable couples via OASIS to other models (currently LFRIC and NEMO). This namelist is only used when running the river standalone program in coupled mode, i.e., compiling with the parameters RIVERS_ONLY and RIVER_CPL
Note
This namelist is only actually used when running the Rivers-only executable (compilation flag RIVERS_ONLY) in coupled mode (compilation flag RIVER_CPL)
6.16.1. OASIS_RIVERS
namelist members¶
- OASIS_RIVERS::np_receive¶
- Type
integer
- Permitted
2
- Default
imdi
The number of fields that are received from other models via OASIS coupling.
- OASIS_RIVERS::np_send¶
- Type
integer
- Permitted
0,1
- Default
imdi
The number of fields that are sent to other models via OASIS coupling.
- OASIS_RIVERS::cpl_freq¶
- Type
integer
- Permitted
1:
- Default
imdi
The river coupling frequency in seconds.
Note
The river coupling frequency must be a multiple of the river executable time step, and of the time steps of the models to which it is coupled.
- OASIS_RIVERS::send_fields¶
- Type
character(:)
- 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 (outflow_per_river).
- OASIS_RIVERS::receive_fields¶
- Type
character(:)
- Permitted
‘sub_surf_roff_rp’, ‘surf_roff_rp’
- Default
‘’
List of fields to be received by the river executable via coupling from other models. Names are case sensitive
Note
Coupled receive fields are used to substitute driving data read from file using the namelist JULES_DRIVE
by the same fields generated by a driving model running in parallel to the river executable. The only fields that can be received via coupling are the surface runoff (surf_roff_rp) and the sub-surface runoff (sub_surf_roff_rp).
- OASIS_RIVERS::riv_number_file¶
- Type
character
- Default
‘’
Ancillary file containing the river number. This information is necessary when sending via coupling the total runoff (
send_fields
= ‘rflow_outflow’), so that rivers discharge in the right ocean grid point. The ancillary file identifies the river in which the river outflow on each grid point will discharge, so the total runoff for each river is calculated as the sum of the river outflow corresponding to that river.
6.16.2. Example of coupling request¶
In this example, the user has requested receiving the surface and sub-surface runoffs, and sending the total river runoff via coupling. The coupling exchanges take place every hour.
&OASIS_RIVERS
cpl_freq = 3600,
np_receive = 2,
np_send = 1,
receive_fields = 'sub_surf_roff_rp','surf_roff_rp',
riv_number_file = '$RIV_NUMBER_ANCILLARY/river_number_um.nc'
send_fields = 'rflow_outflow',
/