flopy.mf6.modflow.mfgwesfe module

class ModflowGwesfe(model, loading_package=False, flow_package_name=None, auxiliary=None, flow_package_auxiliary_name=None, boundnames=None, print_input=None, print_temperature=None, print_flows=None, save_flows=None, temperature_filerecord=None, budget_filerecord=None, budgetcsv_filerecord=None, timeseries=None, observations=None, packagedata=None, reachperioddata=None, filename=None, pname=None, **kwargs)

Bases: MFPackage

ModflowGwesfe defines a SFE 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.

• 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 gwe 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 provided in the corresponding flow package (i.e., flow_package_name). if specified, then the simulated temperatures from this advanced energy 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 energy 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_temperature (keyword) – keyword to indicate that the list of reach {#2} will be printed to the listing file for every stress period in which ‘temperature 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.

• temperature_filerecord ((tempfile)) –

  • tempfilestring

    name of the binary output file to write temperature 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 ([(rno, strt, ktf, rbthcnd, aux, boundname)]) –

  • rnointeger

    integer value that defines the reach number associated with the specified PERIOD data on the line. RNO must be greater than zero and less than or equal to NREACHES.

  • strtdouble precision

    real value that defines the starting temperature for the reach.

  • ktfdouble precision

    is the thermal conductivity of the material between the aquifer cell and the stream reach. The thickness of the material is defined by the variable RBTHCND.

  • rbthcnddouble precision

    real value that defines the thickness of the streambed material through which conduction occurs. Must be greater than 0.

  • aux[double precision]

    represents the values of the auxiliary variables for each reach. The values of auxiliary variables must be present for each reach. The values must be specified in the order of the auxiliary variables specified in the OPTIONS block. If the package supports time series and the Options block includes a TIMESERIESFILE entry (see the ‘Time-Variable Input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

  • boundnamestring

    name of the reach cell. BOUNDNAME is an ASCII character variable that can contain as many as 40 characters. If BOUNDNAME contains spaces in it, then the entire name must be enclosed within single quotes.

• reachperioddata ([(rno, reachsetting)]) –

  • rnointeger

    integer value that defines the reach number associated with the specified period data on the line. rno must be greater than zero and less than or equal to nreaches.

  • reachsettingtemperature | status | rainfall | evaporation | runoff | inflow | auxiliaryrecord

    line of information that is parsed into a keyword and values. keyword values that can be used to start the reachsetting string include: status, temperature, rainfall, evaporation, runoff, and auxiliary. these settings are used to assign the temperature of associated with the corresponding flow terms. temperatures cannot be specified for all flow terms. for example, the streamflow package supports a ‘diversion’ flow term. diversion water will be routed using the calculated temperature of the reach. * temperature : string

    real or character value that defines the temperature for the reach. the specified temperature is only applied if the reach is a constant temperature reach. if the options block includes a timeseriesfile entry (see the ‘time- variable input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

    • statusstring

      keyword option to define reach status. status can be active, inactive, or constant. by default, status is active, which means that temperature will be calculated for the reach. if a reach is inactive, then there will be no energy fluxes into or out of the reach and the inactive value will be written for the reach temperature. if a reach is constant, then the temperature for the reach will be fixed at the user specified value.

    • rainfallstring

      real or character value that defines the rainfall temperature \((e.g.,:^{circ}c:or:^{circ}f)\) for the reach. if the options block includes a timeseriesfile entry (see the ‘time-variable input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

    • evaporationstring

      use of the evaporation keyword is allowed in the sfe package; however, the specified value is not currently used in sfe calculations. instead, the latent heat of evaporation is multiplied by the simulated evaporation rate for determining the thermal energy lost from a stream reach.

    • runoffstring

      real or character value that defines the temperature of runoff \((e.g.,:^{circ}c:or:^{circ}f)\) for the reach. users are free to use whatever temperature scale they want, which might include negative temperatures. if the options block includes a timeseriesfile entry (see the ‘time-variable input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

    • inflowstring

      real or character value that defines the temperature of inflow \((e.g.,:^{circ}c:or:^{circ}f)\) for the reach. users are free to use whatever temperature scale they want, which might include negative temperatures. if the options block includes a timeseriesfile entry (see the ‘time-variable input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

    • auxiliaryrecord(auxiliary, auxname, auxval)

      • auxiliarykeyword

        keyword for specifying auxiliary variable.

      • auxnamestring

        name for the auxiliary variable to be assigned AUXVAL. AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored.

      • auxvaldouble precision

        value for the auxiliary variable. If the Options block includes a TIMESERIESFILE entry (see the ‘Time-Variable Input’ section), values can be obtained from a time series by entering the time-series name in place of a numeric value.

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.

auxiliary = <flopy.mf6.data.mfdatautil.ArrayTemplateGenerator object>

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

budgetcsv_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_temperature', '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 temperature_filerecord', 'type record temperature fileout tempfile', 'shape', 'reader urword', 'tagged true', 'optional true'], ['block options', 'name temperature', 'type keyword', 'shape', 'in_record true', 'reader urword', 'tagged true', 'optional false'], ['block options', 'name tempfile', '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 rno strt ktf rbthcnd aux boundname', 'shape (maxbound)', 'reader urword'], ['block packagedata', 'name rno', '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 ktf', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block packagedata', 'name rbthcnd', '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 rno reachsetting', 'shape', 'reader urword'], ['block period', 'name rno', 'type integer', 'shape', 'tagged false', 'in_record true', 'reader urword', 'numeric_index true'], ['block period', 'name reachsetting', 'type keystring status temperature 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 temperature', '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 = 'gwe-sfe.dfn'

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

package_abbr = 'gwesfe'

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

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

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

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