flopy.mf6.modflow.mfmvt module

class ModflowMvt(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)

Bases: MFPackage

ModflowMvt defines a mvt package.

Parameters:

• parent_model_or_package (MFModel/MFPackage) – 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) – Do not set this parameter. It is intended for debugging and internal processing purposes only.

• print_input (boolean) –

  • print_input (boolean) keyword to indicate that the list of mover information will be written to the listing file immediately after it is read.

• print_flows (boolean) –

  • print_flows (boolean) 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 (boolean) –

  • save_flows (boolean) keyword to indicate that lake flow terms will be written to the file specified with “BUDGET FILEOUT” in Output Control.

• budget_filerecord ([budgetfile]) –

  • budgetfile (string) name of the binary output file to write budget information.

• budgetcsv_filerecord ([budgetcsvfile]) –

  • budgetcsvfile (string) name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.

• 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.

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

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

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

dfn_file_name = 'gwt-mvt.dfn'

package_abbr = 'mvt'

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

Bases: MFChildPackages

MvtPackages is a container class for the ModflowMvt class.

initialize()

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

append_package()

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

append_package(print_input=None, print_flows=None, save_flows=None, budget_filerecord=None, budgetcsv_filerecord=None, filename=None, pname=None)

initialize(print_input=None, print_flows=None, save_flows=None, budget_filerecord=None, budgetcsv_filerecord=None, filename=None, pname=None)

package_abbr = 'mvtpackages'