text: # DO NOT MODIFY THIS FILE DIRECTLY.  THIS FILE MUST BE CREATED BY
  # mf6/utils/createpackages.py
  # FILE created on February 18, 2021 16:23:05 UTC
  from .. import mfpackage
  from ..data.mfdatautil import ListTemplateGenerator
  
  
  class ModflowGwtmwt(mfpackage.MFPackage):
      """
      ModflowGwtmwt defines a mwt package within a gwt6 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.
      flow_package_name : string
          * 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]
          * 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
          * 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 affect.
      boundnames : boolean
          * boundnames (boolean) keyword to indicate that boundary names may be
            provided with the list of well cells.
      print_input : boolean
          * print_input (boolean) keyword to indicate that the list of well
            information will be written to the listing file immediately after it
            is read.
      print_concentration : boolean
          * print_concentration (boolean) keyword to indicate that the list of
            well concentration will be printed to the listing file for every
            stress period in which "HEAD PRINT" is specified in Output Control.
            If there is no Output Control option and PRINT_CONCENTRATION is
            specified, then concentration are printed for the last time step of
            each stress period.
      print_flows : boolean
          * print_flows (boolean) keyword to indicate that the list of well 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 well flow terms will be
            written to the file specified with "BUDGET FILEOUT" in Output
            Control.
      concentration_filerecord : [concfile]
          * concfile (string) name of the binary output file to write
            concentration information.
      budget_filerecord : [budgetfile]
          * budgetfile (string) name of the binary output file to write budget
            information.
      timeseries : {varname:data} or timeseries data
          * Contains data for the ts package. Data can be stored in a dictionary
            containing data for the ts package with variable names as keys and
            package data as values. Data just for the timeseries variable is also
            acceptable. See ts package documentation for more information.
      observations : {varname:data} or continuous data
          * Contains data for the obs package. Data can be stored in a dictionary
            containing data for the obs package with variable names as keys and
            package data as values. Data just for the observations variable is
            also acceptable. See obs package documentation for more information.
      packagedata : [mawno, strt, aux, boundname]
          * mawno (integer) integer value that defines the well number associated
            with the specified PACKAGEDATA data on the line. MAWNO must be
            greater than zero and less than or equal to NMAWWELLS. Well
            information must be specified for every well or the program will
            terminate with an error. The program will also terminate with an
            error if information for a well is specified more than once. This
            argument is an index variable, which means that it should be treated
            as zero-based when working with FloPy and Python. Flopy will
            automatically subtract one when loading index variables and add one
            when writing index variables.
          * strt (double) real value that defines the starting concentration for
            the well.
          * aux (double) represents the values of the auxiliary variables for
            each well. The values of auxiliary variables must be present for each
            well. 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.
          * boundname (string) name of the well 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.
      mwtperioddata : [mawno, mwtsetting]
          * mawno (integer) integer value that defines the well number associated
            with the specified PERIOD data on the line. MAWNO must be greater
            than zero and less than or equal to NMAWWELLS. This argument is an
            index variable, which means that it should be treated as zero-based
            when working with FloPy and Python. Flopy will automatically subtract
            one when loading index variables and add one when writing index
            variables.
          * mwtsetting (keystring) line of information that is parsed into a
            keyword and values. Keyword values that can be used to start the
            MWTSETTING string include: STATUS, CONCENTRATION, RAINFALL,
            EVAPORATION, RUNOFF, and AUXILIARY. These settings are used to assign
            the concentration of associated with the corresponding flow terms.
            Concentrations cannot be specified for all flow terms. For example,
            the Multi-Aquifer Well Package supports a "WITHDRAWAL" flow term. If
            this withdrawal term is active, then water will be withdrawn from the
            well at the calculated concentration of the well.
              status : [string]
                  * status (string) keyword option to define well status. STATUS
                    can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is
                    ACTIVE, which means that concentration will be calculated for
                    the well. If a well is inactive, then there will be no solute
                    mass fluxes into or out of the well and the inactive value
                    will be written for the well concentration. If a well is
                    constant, then the concentration for the well will be fixed
                    at the user specified value.
              concentration : [string]
                  * concentration (string) real or character value that defines
                    the concentration for the well. The specified CONCENTRATION
                    is only applied if the well is a constant concentration well.
                    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.
              rate : [string]
                  * rate (string) real or character value that defines the
                    injection solute concentration :math:`(ML^{-3})` for the
                    well. 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 : [auxname, auxval]
                  * auxname (string) 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.
                  * auxval (double) 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.
      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.
  
      """
  
      auxiliary = ListTemplateGenerator(("gwt6", "mwt", "options", "auxiliary"))
      concentration_filerecord = ListTemplateGenerator(
          ("gwt6", "mwt", "options", "concentration_filerecord")
      )
      budget_filerecord = ListTemplateGenerator(
          ("gwt6", "mwt", "options", "budget_filerecord")
      )
      ts_filerecord = ListTemplateGenerator(
          ("gwt6", "mwt", "options", "ts_filerecord")
      )
      obs_filerecord = ListTemplateGenerator(
          ("gwt6", "mwt", "options", "obs_filerecord")
      )
      packagedata = ListTemplateGenerator(
          ("gwt6", "mwt", "packagedata", "packagedata")
      )
      mwtperioddata = ListTemplateGenerator(
          ("gwt6", "mwt", "period", "mwtperioddata")
      )
      package_abbr = "gwtmwt"
      _package_type = "mwt"
      dfn_file_name = "gwt-mwt.dfn"
  
      dfn = [
          [
              "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 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 continuous",
              "parameter_name observations",
          ],
          [
              "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 mawno strt aux boundname",
              "shape (maxbound)",
              "reader urword",
          ],
          [
              "block packagedata",
              "name mawno",
              "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 mwtperioddata",
              "type recarray mawno mwtsetting",
              "shape",
              "reader urword",
          ],
          [
              "block period",
              "name mawno",
              "type integer",
              "shape",
              "tagged false",
              "in_record true",
              "reader urword",
              "numeric_index true",
          ],
          [
              "block period",
              "name mwtsetting",
              "type keystring status concentration rate 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 rate",
              "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",
          ],
      ]
  
      def __init__(
          self,
          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,
          timeseries=None,
          observations=None,
          packagedata=None,
          mwtperioddata=None,
          filename=None,
          pname=None,
          parent_file=None,
      ):
          super(ModflowGwtmwt, self).__init__(
              model, "mwt", filename, pname, loading_package, parent_file
          )
  
          # set up variables
          self.flow_package_name = self.build_mfdata(
              "flow_package_name", flow_package_name
          )
          self.auxiliary = self.build_mfdata("auxiliary", auxiliary)
          self.flow_package_auxiliary_name = self.build_mfdata(
              "flow_package_auxiliary_name", flow_package_auxiliary_name
          )
          self.boundnames = self.build_mfdata("boundnames", boundnames)
          self.print_input = self.build_mfdata("print_input", print_input)
          self.print_concentration = self.build_mfdata(
              "print_concentration", print_concentration
          )
          self.print_flows = self.build_mfdata("print_flows", print_flows)
          self.save_flows = self.build_mfdata("save_flows", save_flows)
          self.concentration_filerecord = self.build_mfdata(
              "concentration_filerecord", concentration_filerecord
          )
          self.budget_filerecord = self.build_mfdata(
              "budget_filerecord", budget_filerecord
          )
          self._ts_filerecord = self.build_mfdata("ts_filerecord", None)
          self._ts_package = self.build_child_package(
              "ts", timeseries, "timeseries", self._ts_filerecord
          )
          self._obs_filerecord = self.build_mfdata("obs_filerecord", None)
          self._obs_package = self.build_child_package(
              "obs", observations, "continuous", self._obs_filerecord
          )
          self.packagedata = self.build_mfdata("packagedata", packagedata)
          self.mwtperioddata = self.build_mfdata("mwtperioddata", mwtperioddata)
          self._init_complete = True
  