# autogenerated file, do not modify
from os import PathLike, curdir
from typing import Union
from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator
from flopy.mf6.mfpackage import MFChildPackages, MFPackage
[docs]class ModflowMvt(MFPackage):
"""
ModflowMvt defines a MVT package.
Parameters
----------
parent_model_or_package
Parent_model_or_package that this package is a part of. Package is automatically
added to parent_model_or_package when it is initialized.
loading_package : bool, default False
Do not set this parameter. It is intended for debugging and internal
processing purposes only.
print_input : keyword
keyword to indicate that the list of mover information will be written to the
listing file immediately after it is read.
print_flows : keyword
keyword to indicate that the list of lake 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.
save_flows : keyword
keyword to indicate that lake flow terms will be written to the file specified
with 'budget fileout' in output control.
budget_filerecord : record
budgetcsv_filerecord : record
filename : str or PathLike, optional
Name or path of file where this package is stored.
pname : str, optional
Package name.
**kwargs
Extra keywords for :class:`flopy.mf6.mfpackage.MFPackage`.
"""
budget_filerecord = ListTemplateGenerator(("mvt", "options", "budget_filerecord"))
budgetcsv_filerecord = ListTemplateGenerator(
("mvt", "options", "budgetcsv_filerecord")
)
package_abbr = "mvt"
_package_type = "mvt"
dfn_file_name = "gwt-mvt.dfn"
dfn = [
["header"],
[
"block options",
"name print_input",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name print_flows",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name save_flows",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name budget_filerecord",
"type record budget fileout budgetfile",
"shape",
"reader urword",
"tagged true",
"optional true",
],
[
"block options",
"name budget",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name fileout",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name budgetfile",
"type string",
"preserve_case true",
"shape",
"in_record true",
"reader urword",
"tagged false",
"optional false",
],
[
"block options",
"name budgetcsv_filerecord",
"type record budgetcsv fileout budgetcsvfile",
"shape",
"reader urword",
"tagged true",
"optional true",
],
[
"block options",
"name budgetcsv",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name budgetcsvfile",
"type string",
"preserve_case true",
"shape",
"in_record true",
"reader urword",
"tagged false",
"optional false",
],
]
def __init__(
self,
parent_model_or_package,
loading_package=False,
print_input=None,
print_flows=None,
save_flows=None,
budget_filerecord=None,
budgetcsv_filerecord=None,
filename=None,
pname=None,
**kwargs,
):
"""Initialize ModflowMvt."""
super().__init__(
parent=parent_model_or_package,
package_type="mvt",
filename=filename,
pname=pname,
loading_package=loading_package,
**kwargs,
)
self.print_input = self.build_mfdata("print_input", print_input)
self.print_flows = self.build_mfdata("print_flows", print_flows)
self.save_flows = self.build_mfdata("save_flows", save_flows)
self.budget_filerecord = self.build_mfdata(
"budget_filerecord", budget_filerecord
)
self.budgetcsv_filerecord = self.build_mfdata(
"budgetcsv_filerecord", budgetcsv_filerecord
)
self._init_complete = True
[docs]class MvtPackages(MFChildPackages):
"""
MvtPackages is a container class for the ModflowMvt class.
"""
package_abbr = "mvtpackages"
[docs] def initialize(
self,
print_input=None,
print_flows=None,
save_flows=None,
budget_filerecord=None,
budgetcsv_filerecord=None,
filename=None,
pname=None,
):
"""
Initialize a new ModflowMvt package, removing any sibling
child packages attached to the same parent package.
See :class:`ModflowMvt` for parameter definitions.
"""
new_package = ModflowMvt(
self._cpparent,
print_input=print_input,
print_flows=print_flows,
save_flows=save_flows,
budget_filerecord=budget_filerecord,
budgetcsv_filerecord=budgetcsv_filerecord,
filename=filename,
pname=pname,
child_builder_call=True,
)
self.init_package(new_package, filename)
[docs] def append_package(
self,
print_input=None,
print_flows=None,
save_flows=None,
budget_filerecord=None,
budgetcsv_filerecord=None,
filename=None,
pname=None,
):
"""
Add a new ModflowMvt package to the container.
See :class:`ModflowMvt` for parameter definitions.
"""
new_package = ModflowMvt(
self._cpparent,
print_input=print_input,
print_flows=print_flows,
save_flows=save_flows,
budget_filerecord=budget_filerecord,
budgetcsv_filerecord=budgetcsv_filerecord,
filename=filename,
pname=pname,
child_builder_call=True,
)
self._append_package(new_package, filename)