Source code for imod.mf6.riv

import numpy as np

from imod.mf6.pkgbase import BoundaryCondition, VariableMetaData

[docs]class River(BoundaryCondition): """ River package. Any number of RIV Packages can be specified for a single groundwater flow model. Parameters ---------- stage: array of floats (xr.DataArray) is the head in the river. conductance: array of floats (xr.DataArray) is the riverbed hydraulic conductance. bottom_elevation: array of floats (xr.DataArray) is the elevation of the bottom of the riverbed. concentration: array of floats (xr.DataArray, optional) if this flow package is used in simulations also involving transport, then this array is used as the concentration for inflow over this boundary. concentration_boundary_type: ({"AUX", "AUXMIXED"}, optional) if this flow package is used in simulations also involving transport, then this keyword specifies how outflow over this boundary is computed. print_input: ({True, False}, optional) keyword to indicate that the list of drain information will be written to the listing file immediately after it is read. Default is False. print_flows: ({True, False}, optional) Indicates that the list of drain flow rates will be printed to the listing file for every stress period time step in which "BUDGET PRINT" is specified in Output Control. If there is no Output Control option and PRINT FLOWS is specified, then flow rates are printed for the last time step of each stress period. Default is False. save_flows: ({True, False}, optional) Indicates that drain flow terms will be written to the file specified with "BUDGET FILEOUT" in Output Control. Default is False. observations: [Not yet supported.] Default is None. """ _pkg_id = "riv" _period_data = ("stage", "conductance", "bottom_elevation") _keyword_map = {} _metadata_dict = { "stage": VariableMetaData(np.floating), "conductance": VariableMetaData(np.floating), "bottom_elevation": VariableMetaData(np.floating), } _template = BoundaryCondition._initialize_template(_pkg_id) _auxiliary_data = {"concentration": "species"}
[docs] def __init__( self, stage, conductance, bottom_elevation, concentration=None, concentration_boundary_type="aux", print_input=False, print_flows=False, save_flows=False, observations=None, ): super().__init__(locals()) self.dataset["stage"] = stage self.dataset["conductance"] = conductance self.dataset["bottom_elevation"] = bottom_elevation if concentration is not None: self.dataset["concentration"] = concentration self.dataset["concentration_boundary_type"] = concentration_boundary_type self.add_periodic_auxiliary_variable() self.dataset["print_input"] = print_input self.dataset["print_flows"] = print_flows self.dataset["save_flows"] = save_flows self.dataset["observations"] = observations self._pkgcheck()