flopy.mf6.modflow.mfgwtsft module

class ModflowGwtsft(model, loading_package=False, flow_package_name=None, auxiliary=None, flow_package_auxiliary_name=None, boundnames=None, print_input=None, print_concentration=None, print_flows=None, save_flows=None, concentration_filerecord=None, budget_filerecord=None, budgetcsv_filerecord=None, timeseries=None, observations=None, packagedata=None, reachperioddata=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowGwtsft defines a SFT package.

Parameters:

  • flow_package_name (string) – keyword to specify the name of the corresponding flow package. if not specified, then the corresponding flow package must have the same name as this advanced transport package (the name associated with this package in the gwt name file).

  • auxiliary ([string]) – defines an array of one or more auxiliary variable names. there is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. the number of auxiliary variables detected on this line determines the value for naux. comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. the program will terminate with an error if auxiliary variables are specified on more than one line in the options block.

  • flow_package_auxiliary_name (string) – keyword to specify the name of an auxiliary variable in the corresponding flow package. if specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. if the flows for this advanced transport package are read from a file, then this option will have no effect.

  • boundnames (keyword) – keyword to indicate that boundary names may be provided with the list of reach cells.

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

  • print_concentration (keyword) – keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which ‘concentration print’ is specified in output control. if there is no output control option and print_{#3} is specified, then {#2} are printed for the last time step of each stress period.

  • print_flows (keyword) – keyword to indicate that the list of reach 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 reach flow terms will be written to the file specified with ‘budget fileout’ in output control.

  • concentration_filerecord ((concfile)) –

    • concfilestring

      name of the binary output file to write concentration information.

  • budget_filerecord ((budgetfile)) –

    • budgetfilestring

      name of the binary output file to write budget information.

  • budgetcsv_filerecord ((budgetcsvfile)) –

    • budgetcsvfilestring

      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.

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

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

  • packagedata ([list]) –

  • reachperioddata (list) –

auxiliary = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>
budget_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
budgetcsv_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
concentration_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
dfn = [['header', 'multi-package'], ['block options', 'name flow_package_name', 'type string', 'shape', 'reader urword', 'optional true'], ['block options', 'name auxiliary', 'type string', 'shape (naux)', 'reader urword', 'optional true'], ['block options', 'name flow_package_auxiliary_name', 'type string', 'shape', 'reader urword', 'optional true'], ['block options', 'name boundnames', 'type keyword', 'shape', 'reader urword', 'optional true'], ['block options', 'name print_input', 'type keyword', 'reader urword', 'optional true'], ['block options', 'name print_concentration', '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 concentration_filerecord', 'type record concentration fileout concfile', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name concentration', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name concfile', 'type string', 'preserve_case true', 'shape', 'in_record true', 'reader urword', 'tagged false', 'optional false'], ['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'], ['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 options', 'name obs_filerecord', 'type record obs6 filein obs6_filename', 'shape', 'reader urword', 'tagged true', 'optional true', 'construct_package obs', 'construct_data observations', 'parameter_name continuous'], ['block options', 'name obs6', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name obs6_filename', 'type string', 'preserve_case true', 'in_record true', 'tagged false', 'reader urword', 'optional false'], ['block packagedata', 'name packagedata', 'type recarray ifno strt aux boundname', 'shape (maxbound)', 'reader urword'], ['block packagedata', 'name ifno', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block packagedata', 'name strt', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name aux', 'type double precision', 'in_record true', 'tagged false', 'shape (naux)', 'reader urword', 'time_series true', 'optional true'], ['block packagedata', 'name boundname', 'type string', 'shape', 'tagged false', 'in_record true', 'reader urword', 'optional true'], ['block period', 'name iper', 'type integer', 'block_variable True', 'in_record true', 'tagged false', 'shape', 'valid', 'reader urword', 'optional false'], ['block period', 'name reachperioddata', 'type recarray ifno reachsetting', 'shape', 'reader urword'], ['block period', 'name ifno', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block period', 'name reachsetting', 'type keystring status concentration rainfall evaporation runoff inflow auxiliaryrecord', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block period', 'name status', 'type string', 'shape', 'tagged true', 'in_record true', 'reader urword'], ['block period', 'name concentration', 'type string', 'shape', 'tagged true', 'in_record true', 'time_series true', 'reader urword'], ['block period', 'name rainfall', 'type string', 'shape', 'tagged true', 'in_record true', 'reader urword', 'time_series true'], ['block period', 'name evaporation', 'type string', 'shape', 'tagged true', 'in_record true', 'reader urword', 'time_series true'], ['block period', 'name runoff', 'type string', 'shape', 'tagged true', 'in_record true', 'reader urword', 'time_series true'], ['block period', 'name inflow', 'type string', 'shape', 'tagged true', 'in_record true', 'reader urword', 'time_series true'], ['block period', 'name auxiliaryrecord', 'type record auxiliary auxname auxval', 'shape', 'tagged', 'in_record true', 'reader urword'], ['block period', 'name auxiliary', 'type keyword', 'shape', 'in_record true', 'reader urword'], ['block period', 'name auxname', 'type string', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block period', 'name auxval', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword', 'time_series true']]
dfn_file_name = 'gwt-sft.dfn'
obs_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
package_abbr = 'gwtsft'
packagedata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
reachperioddata = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>
ts_filerecord = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>