flopy.mf6.modflow.mfutltvs module

class ModflowUtltvs(parent_package, loading_package=False, disable_storage_change_integration=None, print_input=None, timeseries=None, perioddata=None, filename=None, pname=None, **kwargs)

Bases: MFPackage

ModflowUtltvs defines a TVS package.

Parameters:

• disable_storage_change_integration (keyword) – 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 (keyword) – keyword to indicate that information for each change to a storage property in a cell will be written to the model listing file.

• timeseries (record ts6 filein ts6_filename) – Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information.

• perioddata (list) –

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']]

dfn_file_name = 'utl-tvs.dfn'

package_abbr = 'utltvs'

perioddata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

ts_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>

class UtltvsPackages(model_or_sim, parent, pkg_type, filerecord, package=None, package_class=None)

Bases: MFChildPackages

UtltvsPackages is a container class for the ModflowUtltvs class.

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.

append_package(disable_storage_change_integration=None, print_input=None, timeseries=None, perioddata=None, filename=None, pname=None)

initialize(disable_storage_change_integration=None, print_input=None, timeseries=None, perioddata=None, filename=None, pname=None)

package_abbr = 'utltvspackages'