imod.flow.River#
- class imod.flow.River(conductance, stage, bottom_elevation, infiltration_factor)[source]#
The River package is used to simulate head-dependent flux boundaries. In the River package if the head in the cell falls below a certain threshold, the flux from the river to the model cell is set to a specified lower bound.
- Parameters:
stage (float or xr.DataArray of floats) – is the head in the river (STAGE), dims
("layer", "y", "x")
.bottom_elevation (float or xr.DataArray of floats) – is the bottom of the riverbed (RBOT), dims
("layer", "y", "x")
.conductance (float or xr.DataArray of floats) – is the conductance of the river, dims
("layer", "y", "x")
.infiltration_factor (float or xr.DataArray of floats) –
is the infiltration factor, dims
("layer", "y", "x")
. This factor defines the reduces the conductance for infiltrating water compared to exfiltrating water:cond = A / (c * iff)
where
A
[L2] is the area where surface water and groundwater interact,c
[L] is the resistance, andiff
is the infiltration factor.The infiltration factor is thus equal or larger than 1.
Methods
__init__
(conductance, stage, ...)compose
(directory, globaltimes, nlayer[, ...])Composes all variables for one system.
from_file
(path, **kwargs)Loads an imod-flow package from a file (currently only netcdf and zarr are supported).
isel
()periodic_stress
(periods[, use_cftime])Periodic stress periods.
repeat_stress
([use_cftime])Repeat stress periods.
save
(directory)sel
()