# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY
# mf6/utils/createpackages.py
# FILE created on February 07, 2024 20:16:08 UTC
from .. import mfpackage
from ..data.mfdatautil import ListTemplateGenerator
[docs]class ModflowUtltvs(mfpackage.MFPackage):
"""
ModflowUtltvs defines a tvs package within a utl model.
Parameters
----------
parent_package : MFPackage
Parent_package that this package is a part of. Package is automatically
added to parent_package when it is initialized.
loading_package : bool
Do not set this parameter. It is intended for debugging and internal
processing purposes only.
disable_storage_change_integration : boolean
* disable_storage_change_integration (boolean) keyword that deactivates
inclusion of storage derivative terms in the STO package matrix
formulation. In the absence of this keyword (the default), the
groundwater storage formulation will be modified to correctly adjust
heads based on transient variations in stored water volumes arising
from changes to SS and SY properties.
print_input : boolean
* print_input (boolean) keyword to indicate that information for each
change to a storage property in a cell will be written to the model
listing file.
timeseries : {varname:data} or timeseries data
* Contains data for the ts package. Data can be stored in a dictionary
containing data for the ts package with variable names as keys and
package data as values. Data just for the timeseries variable is also
acceptable. See ts package documentation for more information.
perioddata : [cellid, tvssetting]
* cellid ((integer, ...)) is the cell identifier, and depends on the
type of grid that is used for the simulation. For a structured grid
that uses the DIS input file, CELLID is the layer, row, and column.
For a grid that uses the DISV input file, CELLID is the layer and
CELL2D number. If the model uses the unstructured discretization
(DISU) input file, CELLID is the node number for the cell. This
argument is an index variable, which means that it should be treated
as zero-based when working with FloPy and Python. Flopy will
automatically subtract one when loading index variables and add one
when writing index variables.
* tvssetting (keystring) line of information that is parsed into a
property name keyword and values. Property name keywords that can be
used to start the TVSSETTING string include: SS and SY.
ss : [double]
* ss (double) is the new value to be assigned as the cell's
specific storage (or storage coefficient if the
STORAGECOEFFICIENT STO package option is specified) from the
start of the specified stress period, as per SS in the STO
package. Specific storage values must be greater than or
equal to 0. If the OPTIONS block includes a TS6 entry (see
the "Time-Variable Input" section), values can be obtained
from a time series by entering the time-series name in place
of a numeric value.
sy : [double]
* sy (double) is the new value to be assigned as the cell's
specific yield from the start of the specified stress period,
as per SY in the STO package. Specific yield values must be
greater than or equal to 0. If the OPTIONS block includes a
TS6 entry (see the "Time-Variable Input" section), values can
be obtained from a time series by entering the time-series
name in place of a numeric value.
filename : String
File name for this package.
pname : String
Package name for this package.
parent_file : MFPackage
Parent package file that references this package. Only needed for
utility packages (mfutl*). For example, mfutllaktab package must have
a mfgwflak package parent_file.
"""
ts_filerecord = ListTemplateGenerator(("tvs", "options", "ts_filerecord"))
perioddata = ListTemplateGenerator(("tvs", "period", "perioddata"))
package_abbr = "utltvs"
_package_type = "tvs"
dfn_file_name = "utl-tvs.dfn"
dfn = [
[
"header",
],
[
"block options",
"name disable_storage_change_integration",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name print_input",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name ts_filerecord",
"type record ts6 filein ts6_filename",
"shape",
"reader urword",
"tagged true",
"optional true",
"construct_package ts",
"construct_data timeseries",
"parameter_name timeseries",
],
[
"block options",
"name ts6",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name filein",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name ts6_filename",
"type string",
"preserve_case true",
"in_record true",
"reader urword",
"optional false",
"tagged false",
],
[
"block period",
"name iper",
"type integer",
"block_variable True",
"in_record true",
"tagged false",
"shape",
"valid",
"reader urword",
"optional false",
],
[
"block period",
"name perioddata",
"type recarray cellid tvssetting",
"shape",
"reader urword",
],
[
"block period",
"name cellid",
"type integer",
"shape (ncelldim)",
"tagged false",
"in_record true",
"reader urword",
],
[
"block period",
"name tvssetting",
"type keystring ss sy",
"shape",
"tagged false",
"in_record true",
"reader urword",
],
[
"block period",
"name ss",
"type double precision",
"shape",
"tagged true",
"in_record true",
"reader urword",
"time_series true",
],
[
"block period",
"name sy",
"type double precision",
"shape",
"tagged true",
"in_record true",
"reader urword",
"time_series true",
],
]
def __init__(
self,
parent_package,
loading_package=False,
disable_storage_change_integration=None,
print_input=None,
timeseries=None,
perioddata=None,
filename=None,
pname=None,
**kwargs,
):
super().__init__(
parent_package, "tvs", filename, pname, loading_package, **kwargs
)
# set up variables
self.disable_storage_change_integration = self.build_mfdata(
"disable_storage_change_integration",
disable_storage_change_integration,
)
self.print_input = self.build_mfdata("print_input", print_input)
self._ts_filerecord = self.build_mfdata("ts_filerecord", None)
self._ts_package = self.build_child_package(
"ts", timeseries, "timeseries", self._ts_filerecord
)
self.perioddata = self.build_mfdata("perioddata", perioddata)
self._init_complete = True
[docs]class UtltvsPackages(mfpackage.MFChildPackages):
"""
UtltvsPackages is a container class for the ModflowUtltvs class.
Methods
----------
initialize
Initializes a new ModflowUtltvs package removing any sibling child
packages attached to the same parent package. See ModflowUtltvs init
documentation for definition of parameters.
append_package
Adds a new ModflowUtltvs package to the container. See ModflowUtltvs
init documentation for definition of parameters.
"""
package_abbr = "utltvspackages"
[docs] def initialize(
self,
disable_storage_change_integration=None,
print_input=None,
timeseries=None,
perioddata=None,
filename=None,
pname=None,
):
new_package = ModflowUtltvs(
self._cpparent,
disable_storage_change_integration=disable_storage_change_integration,
print_input=print_input,
timeseries=timeseries,
perioddata=perioddata,
filename=filename,
pname=pname,
child_builder_call=True,
)
self.init_package(new_package, filename)
[docs] def append_package(
self,
disable_storage_change_integration=None,
print_input=None,
timeseries=None,
perioddata=None,
filename=None,
pname=None,
):
new_package = ModflowUtltvs(
self._cpparent,
disable_storage_change_integration=disable_storage_change_integration,
print_input=print_input,
timeseries=timeseries,
perioddata=perioddata,
filename=filename,
pname=pname,
child_builder_call=True,
)
self._append_package(new_package, filename)