"""
mfriv module. Contains the ModflowRiv class. Note that the user can access
the ModflowRiv class as `flopy.modflow.ModflowRiv`.
Additional information for this MODFLOW package can be found at the `Online
MODFLOW Guide
<https://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/riv.html>`_.
"""
import numpy as np
import pandas as pd
from ..pakbase import Package
from ..utils import MfList
from ..utils.recarray_utils import create_empty_recarray
[docs]class ModflowRiv(Package):
"""
MODFLOW River Package Class.
Parameters
----------
model : model object
The model object (of type :class:`flopy.modflow.mf.Modflow`) to which
this package will be added.
ipakcb : int, optional
Toggles whether cell-by-cell budget data should be saved. If None or zero,
budget data will not be saved (default is None).
stress_period_data : list, recarray, dataframe, or dictionary of boundaries.
Each river cell is defined through definition of
layer (int), row (int), column (int), stage (float), cond (float),
rbot (float).
The simplest form is a dictionary with a lists of boundaries for each
stress period, where each list of boundaries itself is a list of
boundaries. Indices of the dictionary are the numbers of the stress
period. This gives the form of::
stress_period_data =
{0: [
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot]
],
1: [
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot]
], ...
kper:
[
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot],
[lay, row, col, stage, cond, rbot]
]
}
Note that if the number of lists is smaller than the number of stress
periods, then the last list of rivers will apply until the end of the
simulation. Full details of all options to specify stress_period_data
can be found in the flopy3 boundaries Notebook in the basic
subdirectory of the examples directory.
dtype : custom datatype of stress_period_data.
(default is None)
If None the default river datatype will be applied.
naux : int
number of auxiliary variables
extension : string
Filename extension (default is 'riv')
options : list of strings
Package options. (default is None).
unitnumber : int
File unit number (default is None).
filenames : str or list of str
Filenames to use for the package and the output files. If
filenames=None the package name will be created using the model name
and package extension and the cbc output name will be created using
the model name and .cbc extension (for example, modflowtest.cbc),
if ipakcb is a number greater than zero. If a single string is passed
the package will be set to the string and cbc output names will be
created using the model name and .cbc extension, if ipakcb is a
number greater than zero. To define the names for all package files
(input and output) the length of the list of strings should be 2.
Default is None.
Attributes
----------
mxactr : int
Maximum number of river cells for a stress period. This is calculated
automatically by FloPy based on the information in
layer_row_column_data.
Methods
-------
See Also
--------
Notes
-----
Parameters are not supported in FloPy.
Examples
--------
>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> lrcd = {}
>>> lrcd[0] = [[2, 3, 4, 15.6, 1050., -4]] #this river boundary will be
>>> #applied to all stress periods
>>> riv = flopy.modflow.ModflowRiv(m, stress_period_data=lrcd)
"""
def __init__(
self,
model,
ipakcb=None,
stress_period_data=None,
dtype=None,
extension="riv",
options=None,
unitnumber=None,
filenames=None,
**kwargs,
):
# set default unit number of one is not specified
if unitnumber is None:
unitnumber = ModflowRiv._defaultunit()
# set filenames
filenames = self._prepare_filenames(filenames, 2)
# cbc output file
self.set_cbc_output_file(ipakcb, model, filenames[1])
# call base package constructor
super().__init__(
model,
extension=extension,
name=self._ftype(),
unit_number=unitnumber,
filenames=filenames[0],
)
self._generate_heading()
self.url = "riv.html"
self.mxactr = 0
self.np = 0
if options is None:
options = []
self.options = options
if dtype is not None:
self.dtype = dtype
else:
self.dtype = self.get_default_dtype(
structured=self.parent.structured
)
self.stress_period_data = MfList(self, stress_period_data)
self.parent.add_package(self)
[docs] def check(self, f=None, verbose=True, level=1, checktype=None):
"""
Check package data for common errors.
Parameters
----------
f : str or file handle
String defining file name or file handle for summary file
of check method output. If a string is passed a file handle
is created. If f is None, check method does not write
results to a summary file. (default is None)
verbose : bool
Boolean flag used to determine if check method results are
written to the screen.
level : int
Check method analysis level. If level=0, summary checks are
performed. If level=1, full checks are performed.
Returns
-------
None
Examples
--------
>>> import flopy
>>> m = flopy.modflow.Modflow.load('model.nam')
>>> m.riv.check()
"""
basechk = super().check(verbose=False, checktype=checktype)
chk = self._get_check(f, verbose, level, checktype)
chk.summary_array = basechk.summary_array
for per, data in self.stress_period_data.data.items():
if isinstance(data, (np.recarray, pd.DataFrame)):
if isinstance(data, pd.DataFrame):
data = data.to_records(index=False).astype(self.dtype)
spd = data
inds = (
(spd.k, spd.i, spd.j)
if self.parent.structured
else (spd.node)
)
# check that river stage and bottom are above model cell
# bottoms also checks for nan values
if self.parent.structured:
botms = self.parent.dis.botm.array[inds]
else:
botms = self.parent.disu.bot.array[inds]
for elev in ["stage", "rbot"]:
txt = f"{elev} below cell bottom"
chk.stress_period_data_values(
spd,
spd[elev] < botms,
col=elev,
error_name=txt,
error_type="Error",
)
# check that river stage is above the rbot
txt = "RIV stage below rbots"
chk.stress_period_data_values(
spd,
spd["rbot"] > spd["stage"],
col="stage",
error_name=txt,
error_type="Error",
)
chk.summarize()
return chk
[docs] @staticmethod
def get_empty(ncells=0, aux_names=None, structured=True):
# get an empty recarray that corresponds to dtype
dtype = ModflowRiv.get_default_dtype(structured=structured)
if aux_names is not None:
dtype = Package.add_to_dtype(dtype, aux_names, np.float32)
return create_empty_recarray(ncells, dtype, default_value=-1.0e10)
[docs] @staticmethod
def get_default_dtype(structured=True):
if structured:
dtype = np.dtype(
[
("k", int),
("i", int),
("j", int),
("stage", np.float32),
("cond", np.float32),
("rbot", np.float32),
]
)
else:
dtype = np.dtype(
[
("node", int),
("stage", np.float32),
("cond", np.float32),
("rbot", np.float32),
]
)
return dtype
@staticmethod
def _get_sfac_columns():
return ["cond"]
def _ncells(self):
"""Maximum number of cells that have rivers (developed for
MT3DMS SSM package).
Returns
-------
ncells: int
maximum number of riv cells
"""
return self.stress_period_data.mxact
[docs] def write_file(self, check=True):
"""
Write the package file.
Parameters
----------
check : boolean
Check package data for common errors. (default True)
Returns
-------
None
"""
# allows turning off package checks when writing files at model level
if check:
self.check(
f=f"{self.name[0]}.chk",
verbose=self.parent.verbose,
level=1,
)
f_riv = open(self.fn_path, "w")
f_riv.write(f"{self.heading}\n")
line = f"{self.stress_period_data.mxact:10d}{self.ipakcb:10d}"
for opt in self.options:
line += " " + str(opt)
line += "\n"
f_riv.write(line)
self.stress_period_data.write_transient(f_riv)
f_riv.close()
[docs] def add_record(self, kper, index, values):
try:
self.stress_period_data.add_record(kper, index, values)
except Exception as e:
raise Exception(f"mfriv error adding record to list: {e!s}")
[docs] @classmethod
def load(cls, f, model, nper=None, ext_unit_dict=None, check=True):
"""
Load an existing package.
Parameters
----------
f : filename or file handle
File to load.
model : model object
The model object (of type :class:`flopy.modflow.mf.Modflow`) to
which this package will be added.
nper : int
The number of stress periods. If nper is None, then nper will be
obtained from the model object. (default is None).
ext_unit_dict : dictionary, optional
If the arrays in the file are specified using EXTERNAL,
or older style array control records, then `f` should be a file
handle. In this case ext_unit_dict is required, which can be
constructed using the function
:class:`flopy.utils.mfreadnam.parsenamefile`.
check : boolean
Check package data for common errors. (default True)
Returns
-------
rch : ModflowRiv object
ModflowRiv object.
Examples
--------
>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> riv = flopy.modflow.ModflowRiv.load('test.riv', m)
"""
if model.verbose:
print("loading riv package file...")
return Package.load(
f,
model,
cls,
nper=nper,
check=check,
ext_unit_dict=ext_unit_dict,
)
@staticmethod
def _ftype():
return "RIV"
@staticmethod
def _defaultunit():
return 18