flopy.mf6.modflow.mfutlts module

class ModflowUtlts(model, loading_package=False, time_series_namerecord=None, interpolation_methodrecord=None, interpolation_methodrecord_single=None, sfacrecord=None, sfacrecord_single=None, timeseries=None, filename=None, pname=None, parent_file=None)

Bases: flopy.mf6.mfpackage.MFPackage

ModflowUtlts defines a ts package within a utl model.

Parameters:

• model (MFModel) – Model that this package is a part of. Package is automatically added to model when it is initialized.
• loading_package (bool) – Do not set this parameter. It is intended for debugging and internal processing purposes only.
• time_series_namerecord ([time_series_names]) –
  • time_series_names (string) Name by which a package references a particular time-array series. The name must be unique among all time- array series used in a package.
• interpolation_methodrecord ([interpolation_method]) –
  • interpolation_method (string) Interpolation method, which is either STEPWISE or LINEAR.
• interpolation_methodrecord_single ([interpolation_method_single]) –
  • interpolation_method_single (string) Interpolation method, which is either STEPWISE or LINEAR.
• sfacrecord ([sfacval]) –
  • sfacval (double) Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.
• sfacrecord_single ([sfacval]) –
  • sfacval (double) Scale factor, which will multiply all array values in time series. SFAC is an optional attribute; if omitted, SFAC = 1.0.
• timeseries ([ts_time, ts_array]) –
  • ts_time (double) A numeric time relative to the start of the simulation, in the time unit used in the simulation. Times must be strictly increasing.
  • ts_array (double) A 2-D array of numeric, floating-point values, or a constant value, readable by the U2DREL array-reading utility.
• 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.

dfn = [['block attributes', 'name time_series_namerecord', 'type record names time_series_names', 'shape', 'reader urword', 'tagged false', 'optional false'], ['block attributes', 'name names', 'other_names name', 'type keyword', 'shape', 'reader urword', 'optional false'], ['block attributes', 'name time_series_names', 'type string', 'shape any1d', 'tagged false', 'reader urword', 'optional false'], ['block attributes', 'name interpolation_methodrecord', 'type record methods interpolation_method', 'shape', 'reader urword', 'tagged false', 'optional true'], ['block attributes', 'name methods', 'type keyword', 'shape', 'reader urword', 'optional false'], ['block attributes', 'name interpolation_method', 'type string', 'valid stepwise linear linearend', 'shape time_series_names', 'tagged false', 'reader urword', 'optional false'], ['block attributes', 'name interpolation_methodrecord_single', 'type record method interpolation_method_single', 'shape', 'reader urword', 'tagged false', 'optional true'], ['block attributes', 'name method', 'type keyword', 'shape', 'reader urword', 'optional false'], ['block attributes', 'name interpolation_method_single', 'type string', 'valid stepwise linear linearend', 'shape', 'tagged false', 'reader urword', 'optional false'], ['block attributes', 'name sfacrecord', 'type record sfacs sfacval', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block attributes', 'name sfacs', 'type keyword', 'shape', 'reader urword', 'optional false'], ['block attributes', 'name sfacval', 'type double precision', 'shape <time_series_name', 'tagged false', 'reader urword', 'optional false'], ['block attributes', 'name sfacrecord_single', 'type record sfac sfacval', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block attributes', 'name sfac', 'type keyword', 'shape', 'tagged false', 'reader urword', 'optional false'], ['block timeseries', 'name timeseries', 'type recarray ts_time ts_array', 'shape', 'reader urword', 'tagged true', 'optional false'], ['block timeseries', 'name ts_time', 'type double precision', 'shape', 'tagged false', 'reader urword', 'optional false', 'repeating false'], ['block timeseries', 'name ts_array', 'type double precision', 'shape time_series_names', 'tagged false', 'reader urword', 'optional false']]

dfn_file_name = 'utl-ts.dfn'

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

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

package_abbr = 'utlts'

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

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

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

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

class UtltsPackages(model, parent, pkg_type, filerecord, package=None, package_class=None)

Bases: flopy.mf6.mfpackage.MFChildPackages

UtltsPackages is a container class for the ModflowUtlts class.

initialize()

Initializes a new ModflowUtlts package removing any sibling child packages attached to the same parent package. See ModflowUtlts init documentation for definition of parameters.

append_package()

Adds a new ModflowUtlts package to the container. See ModflowUtlts init documentation for definition of parameters.

append_package(time_series_namerecord=None, interpolation_methodrecord=None, interpolation_methodrecord_single=None, sfacrecord=None, sfacrecord_single=None, timeseries=None, filename=None, pname=None)

initialize(time_series_namerecord=None, interpolation_methodrecord=None, interpolation_methodrecord_single=None, sfacrecord=None, sfacrecord_single=None, timeseries=None, filename=None, pname=None)

package_abbr = 'utltspackages'