How to use the flopy.mf6.data.mfdatautil.ListTemplateGenerator function in flopy

To help you get started, we’ve selected a few flopy examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github modflowpy / flopy / flopy / mf6 / modflow / mfgwfsfr.py View on Github external
a mfgwflak package parent_file.

    """
    auxiliary = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                       'auxiliary'))
    stage_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                              'stage_filerecord'))
    budget_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                               'budget_filerecord'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                            'obs_filerecord'))
    packagedata = ListTemplateGenerator(('gwf6', 'sfr', 'packagedata',
                                         'packagedata'))
    connectiondata = ListTemplateGenerator(('gwf6', 'sfr',
                                            'connectiondata',
                                            'connectiondata'))
    diversions = ListTemplateGenerator(('gwf6', 'sfr', 'diversions',
                                        'diversions'))
    perioddata = ListTemplateGenerator(('gwf6', 'sfr', 'period',
                                        'perioddata'))
    package_abbr = "gwfsfr"
    _package_type = "sfr"
    dfn_file_name = "gwf-sfr.dfn"

    dfn = [["block options", "name auxiliary", "type string",
            "shape (naux)", "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"],
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfrch.py View on Github external
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.
    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(('gwf6', 'rch', 'options',
                                       'auxiliary'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'rch', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'rch', 'options',
                                            'obs_filerecord'))
    stress_period_data = ListTemplateGenerator(('gwf6', 'rch', 'period',
                                                'stress_period_data'))
    package_abbr = "gwfrch"
    _package_type = "rch"
    dfn_file_name = "gwf-rch.dfn"

    dfn = [["block options", "name fixed_cell", "type keyword", "shape",
            "reader urword", "optional true"],
           ["block options", "name auxiliary", "type string",
            "shape (naux)", "reader urword", "optional true"],
           ["block options", "name auxmultname", "type string", "shape",
            "reader urword", "optional true"],
           ["block options", "name boundnames", "type keyword", "shape",
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfevt.py View on Github external
must be enclosed within single quotes.
    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(('gwf6', 'evt', 'options',
                                       'auxiliary'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'evt', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'evt', 'options',
                                            'obs_filerecord'))
    stress_period_data = ListTemplateGenerator(('gwf6', 'evt', 'period',
                                                'stress_period_data'))
    package_abbr = "gwfevt"
    _package_type = "evt"
    dfn_file_name = "gwf-evt.dfn"

    dfn = [["block options", "name fixed_cell", "type keyword", "shape",
            "reader urword", "optional true"],
           ["block options", "name auxiliary", "type string",
            "shape (naux)", "reader urword", "optional true"],
           ["block options", "name auxmultname", "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",
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfmaw.py View on Github external
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(('gwf6', 'maw', 'options',
                                       'auxiliary'))
    stage_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                              'stage_filerecord'))
    budget_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                               'budget_filerecord'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                            'obs_filerecord'))
    packagedata = ListTemplateGenerator(('gwf6', 'maw', 'packagedata',
                                         'packagedata'))
    connectiondata = ListTemplateGenerator(('gwf6', 'maw',
                                            'connectiondata',
                                            'connectiondata'))
    perioddata = ListTemplateGenerator(('gwf6', 'maw', 'period',
                                        'perioddata'))
    package_abbr = "gwfmaw"
    _package_type = "maw"
github modflowpy / flopy / flopy / mf6 / modflow / mfmvr.py View on Github external
diverting stream flow.
        * value (double) is the value to be used in the equation for
          calculating the amount of water to move. For the "FACTOR" option,
          VALUE is the :math:`\\alpha` factor. For the remaining options, VALUE
          is the specified flow rate, :math:`Q_S`.
    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 = ListTemplateGenerator(('mvr', 'options',
                                               'budget_filerecord'))
    packages = ListTemplateGenerator(('mvr', 'packages', 'packages'))
    perioddata = ListTemplateGenerator(('mvr', 'period', 'perioddata'))
    package_abbr = "mvr"
    _package_type = "mvr"
    dfn_file_name = "gwf-mvr.dfn"

    dfn = [["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 modelnames", "type keyword",
            "reader urword", "optional true"],
           ["block options", "name budget_filerecord",
            "type record budget fileout budgetfile", "shape", "reader urword",
            "tagged true", "optional true"],
github modflowpy / flopy / flopy / mf6 / modflow / mfutlts.py View on Github external
strictly increasing.
        * ts_array (double) A 2-D array of numeric, floating-point values, or a
          constant value, readable by the U2DREL array-reading utility.
    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.

    """
    time_series_namerecord = ListTemplateGenerator(('ts', 'attributes',
                                                    'time_series_namerecord'))
    interpolation_methodrecord = ListTemplateGenerator((
        'ts', 'attributes', 'interpolation_methodrecord'))
    interpolation_methodrecord_single = ListTemplateGenerator((
        'ts', 'attributes', 'interpolation_methodrecord_single'))
    sfacrecord = ListTemplateGenerator(('ts', 'attributes', 'sfacrecord'))
    sfacrecord_single = ListTemplateGenerator(('ts', 'attributes',
                                               'sfacrecord_single'))
    timeseries = ListTemplateGenerator(('ts', 'timeseries', 'timeseries'))
    package_abbr = "utlts"
    _package_type = "ts"
    dfn_file_name = "utl-ts.dfn"

    dfn = [["block attributes", "name time_series_namerecord",
            "type record names time_series_names", "shape", "reader urword",
            "tagged false", "optional false"],
           ["block attributes", "name names", "other_names name",
            "type keyword", "shape", "reader urword", "optional false"],
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfdisu.py View on Github external
'idomain'))
    iac = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                  'iac'))
    ja = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                 'ja'))
    ihc = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                  'ihc'))
    cl12 = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                   'cl12'))
    hwva = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                   'hwva'))
    angldegx = ArrayTemplateGenerator(('gwf6', 'disu', 'connectiondata',
                                       'angldegx'))
    vertices = ListTemplateGenerator(('gwf6', 'disu', 'vertices',
                                      'vertices'))
    cell2d = ListTemplateGenerator(('gwf6', 'disu', 'cell2d', 'cell2d'))
    package_abbr = "gwfdisu"
    _package_type = "disu"
    dfn_file_name = "gwf-disu.dfn"

    dfn = [["block options", "name length_units", "type string",
            "reader urword", "optional true"],
           ["block options", "name nogrb", "type keyword", "reader urword",
            "optional true"],
           ["block options", "name xorigin", "type double precision",
            "reader urword", "optional true"],
           ["block options", "name yorigin", "type double precision",
            "reader urword", "optional true"],
           ["block options", "name angrot", "type double precision",
            "reader urword", "optional true"],
           ["block dimensions", "name nodes", "type integer",
            "reader urword", "optional false"],
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfsfr.py View on Github external
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(('gwf6', 'sfr', 'options',
                                       'auxiliary'))
    stage_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                              'stage_filerecord'))
    budget_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                               'budget_filerecord'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'sfr', 'options',
                                            'obs_filerecord'))
    packagedata = ListTemplateGenerator(('gwf6', 'sfr', 'packagedata',
                                         'packagedata'))
    connectiondata = ListTemplateGenerator(('gwf6', 'sfr',
                                            'connectiondata',
                                            'connectiondata'))
    diversions = ListTemplateGenerator(('gwf6', 'sfr', 'diversions',
                                        'diversions'))
    perioddata = ListTemplateGenerator(('gwf6', 'sfr', 'period',
                                        'perioddata'))
    package_abbr = "gwfsfr"
    _package_type = "sfr"
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfmaw.py View on Github external
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(('gwf6', 'maw', 'options',
                                       'auxiliary'))
    stage_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                              'stage_filerecord'))
    budget_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                               'budget_filerecord'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'maw', 'options',
                                            'obs_filerecord'))
    packagedata = ListTemplateGenerator(('gwf6', 'maw', 'packagedata',
                                         'packagedata'))
    connectiondata = ListTemplateGenerator(('gwf6', 'maw',
                                            'connectiondata',
                                            'connectiondata'))
    perioddata = ListTemplateGenerator(('gwf6', 'maw', 'period',
                                        'perioddata'))
    package_abbr = "gwfmaw"
    _package_type = "maw"
    dfn_file_name = "gwf-maw.dfn"

    dfn = [["block options", "name auxiliary", "type string",
            "shape (naux)", "reader urword", "optional true"],
           ["block options", "name boundnames", "type keyword", "shape",
            "reader urword", "optional true"],
github modflowpy / flopy / flopy / mf6 / modflow / mfgwfrch.py View on Github external
numeric value.
        * boundname (string) name of the recharge 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.
    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(('gwf6', 'rch', 'options',
                                       'auxiliary'))
    ts_filerecord = ListTemplateGenerator(('gwf6', 'rch', 'options',
                                           'ts_filerecord'))
    obs_filerecord = ListTemplateGenerator(('gwf6', 'rch', 'options',
                                            'obs_filerecord'))
    stress_period_data = ListTemplateGenerator(('gwf6', 'rch', 'period',
                                                'stress_period_data'))
    package_abbr = "gwfrch"
    _package_type = "rch"
    dfn_file_name = "gwf-rch.dfn"

    dfn = [["block options", "name fixed_cell", "type keyword", "shape",
            "reader urword", "optional true"],
           ["block options", "name auxiliary", "type string",
            "shape (naux)", "reader urword", "optional true"],
           ["block options", "name auxmultname", "type string", "shape",