flopy.mf6.modflow.mfgwtssm module

class ModflowGwtssm(model, loading_package=False, print_flows=None, save_flows=None, sources=None, fileinput=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowGwtssm defines a SSM package.

Parameters:

  • model – Model that this package is a part of. Package is automatically added to model 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_flows (keyword) – keyword to indicate that the list of ssm 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 ssm flow terms will be written to the file specified with ‘budget fileout’ in output control.

  • sources ([(pname, srctype, auxname)]) –

    • pnamestring

      name of the flow package for which an SPC6 input file contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here.

    • srctypestring

      keyword indicating how concentration will be assigned for sources and sinks. Keyword must be specified as either AUX or AUXMIXED. For both options the user must provide an auxiliary variable in the corresponding flow package. The auxiliary variable must have the same name as the AUXNAME value that follows. If the AUX keyword is specified, then the auxiliary variable specified by the user will be assigned as the concentration value for groundwater sources (flows with a positive sign). For negative flow rates (sinks), groundwater will be withdrawn from the cell at the simulated concentration of the cell. The AUXMIXED option provides an alternative method for how to determine the concentration of sinks. If the cell concentration is larger than the user- specified auxiliary concentration, then the concentration of groundwater withdrawn from the cell will be assigned as the user-specified concentration. Alternatively, if the user-specified auxiliary concentration is larger than the cell concentration, then groundwater will be withdrawn at the cell concentration. Thus, the AUXMIXED option is designed to work with the Evapotranspiration (EVT) and Recharge (RCH) Packages where water may be withdrawn at a concentration that is less than the cell concentration.

    • auxnamestring

      name of the auxiliary variable in the package PNAME. This auxiliary variable must exist and be specified by the user in that package. The values in this auxiliary variable will be used to set the concentration associated with the flows for that boundary package.

  • fileinput ([(pname, spc6, filein, spc6_filename, mixed)]) –

    • pnamestring

      name of the flow package for which an SPC6 input file contains a source concentration. If this flow package is represented using an advanced transport package (SFT, LKT, MWT, or UZT), then the advanced transport package will override SSM terms specified here.

    • spc6keyword

      keyword to specify that record corresponds to a source sink mixing input file.

    • fileinkeyword

      keyword to specify that an input filename is expected next.

    • spc6_filenamestring

      character string that defines the path and filename for the file containing source and sink input data for the flow package. The SPC6_FILENAME file is a flexible input file that allows concentrations to be specified by stress period and with time series. Instructions for creating the SPC6_FILENAME input file are provided in the next section on file input for boundary concentrations.

    • mixedkeyword

      keyword to specify that these stress package boundaries will have the mixed condition. The MIXED condition is described in the SOURCES block for AUXMIXED. The MIXED condition allows for water to be withdrawn at a concentration that is less than the cell concentration. It is intended primarily for representing evapotranspiration.

filenamestr or PathLike, optional

Name or path of file where this package is stored.

pnamestr, optional

Package name.

**kwargs

Extra keywords for flopy.mf6.mfpackage.MFPackage.

dfn = [['header'], ['block options', 'name print_flows', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name save_flows', 'type keyword', 'reader urword', 'optional true'], ['block sources', 'name sources', 'type recarray pname srctype auxname', 'reader urword', 'optional false'], ['block sources', 'name pname', 'in_record true', 'type string', 'tagged false', 'reader urword', 'mf6internal pname_sources'], ['block sources', 'name srctype', 'in_record true', 'type string', 'tagged false', 'optional false', 'reader urword'], ['block sources', 'name auxname', 'in_record true', 'type string', 'tagged false', 'reader urword', 'optional false'], ['block fileinput', 'name fileinput', 'type recarray pname spc6 filein spc6_filename mixed', 'reader urword', 'optional true'], ['block fileinput', 'name pname', 'in_record true', 'type string', 'tagged false', 'reader urword'], ['block fileinput', 'name spc6', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block fileinput', 'name filein', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block fileinput', 'name spc6_filename', 'type string', 'preserve_case true', 'in_record true', 'reader urword', 'optional false', 'tagged false'], ['block fileinput', 'name mixed', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional true']]
dfn_file_name = 'gwt-ssm.dfn'
fileinput = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
package_abbr = 'gwtssm'
sources = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>