# autogenerated file, do not modify
from os import PathLike, curdir
from typing import Union
from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator
from flopy.mf6.mfpackage import MFChildPackages, MFPackage
[docs]class ModflowGwenam(MFPackage):
"""
ModflowGwenam defines a NAM package.
Parameters
----------
list : string
is name of the listing file to create for this gwe model. if not specified,
then the name of the list file will be the basename of the gwe model name file
and the '.lst' extension. for example, if the gwe name file is called
'my.model.nam' then the list file will be called 'my.model.lst'.
print_input : keyword
keyword to indicate that the list of all model stress package information will
be written to the listing file immediately after it is read.
print_flows : keyword
keyword to indicate that the list of all model package 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 all model package flow terms will be written to the
file specified with 'budget fileout' in output control.
nc_mesh2d_filerecord : (ncmesh2dfile)
netcdf layered mesh fileout record.
* ncmesh2dfile : string
name of the netcdf ugrid layered mesh output file.
nc_structured_filerecord : (ncstructfile)
netcdf structured fileout record.
* ncstructfile : string
name of the netcdf structured output file.
nc_filerecord : (netcdf_filename)
netcdf filerecord
* netcdf_filename : string
defines a netcdf input file.
packages : list
"""
nc_mesh2d_filerecord = ListTemplateGenerator(
("gwe6", "nam", "options", "nc_mesh2d_filerecord")
)
nc_structured_filerecord = ListTemplateGenerator(
("gwe6", "nam", "options", "nc_structured_filerecord")
)
nc_filerecord = ListTemplateGenerator(("gwe6", "nam", "options", "nc_filerecord"))
packages = ListTemplateGenerator(("gwe6", "nam", "packages", "packages"))
package_abbr = "gwenam"
_package_type = "nam"
dfn_file_name = "gwe-nam.dfn"
dfn = [
["header"],
[
"block options",
"name list",
"type string",
"reader urword",
"optional true",
"preserve_case true",
],
[
"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 save_flows",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name nc_mesh2d_filerecord",
"type record netcdf_mesh2d fileout ncmesh2dfile",
"shape",
"reader urword",
"tagged true",
"optional true",
"mf6internal ncmesh2drec",
],
[
"block options",
"name netcdf_mesh2d",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
"extended true",
],
[
"block options",
"name nc_structured_filerecord",
"type record netcdf_structured fileout ncstructfile",
"shape",
"reader urword",
"tagged true",
"optional true",
"mf6internal ncstructrec",
],
[
"block options",
"name netcdf_structured",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
"mf6internal netcdf_struct",
"extended true",
],
[
"block options",
"name fileout",
"type keyword",
"shape",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name ncmesh2dfile",
"type string",
"preserve_case true",
"shape",
"in_record true",
"reader urword",
"tagged false",
"optional false",
"extended true",
],
[
"block options",
"name ncstructfile",
"type string",
"preserve_case true",
"shape",
"in_record true",
"reader urword",
"tagged false",
"optional false",
"extended true",
],
[
"block options",
"name nc_filerecord",
"type record netcdf filein netcdf_filename",
"reader urword",
"tagged true",
"optional true",
],
[
"block options",
"name netcdf",
"type keyword",
"in_record true",
"reader urword",
"tagged true",
"optional false",
"extended true",
],
[
"block options",
"name filein",
"type keyword",
"in_record true",
"reader urword",
"tagged true",
"optional false",
],
[
"block options",
"name netcdf_filename",
"type string",
"preserve_case true",
"in_record true",
"reader urword",
"optional false",
"tagged false",
"mf6internal netcdf_fname",
"extended true",
],
[
"block packages",
"name packages",
"type recarray ftype fname pname",
"reader urword",
"optional false",
],
[
"block packages",
"name ftype",
"in_record true",
"type string",
"tagged false",
"reader urword",
],
[
"block packages",
"name fname",
"in_record true",
"type string",
"preserve_case true",
"tagged false",
"reader urword",
],
[
"block packages",
"name pname",
"in_record true",
"type string",
"tagged false",
"reader urword",
"optional true",
],
]
def __init__(
self,
model,
loading_package=False,
list=None,
print_input=None,
print_flows=None,
save_flows=None,
nc_mesh2d_filerecord=None,
nc_structured_filerecord=None,
nc_filerecord=None,
packages=None,
filename=None,
pname=None,
**kwargs,
):
"""
ModflowGwenam defines a NAM package.
Parameters
----------
model
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.
list : string
is name of the listing file to create for this gwe model. if not specified,
then the name of the list file will be the basename of the gwe model name file
and the '.lst' extension. for example, if the gwe name file is called
'my.model.nam' then the list file will be called 'my.model.lst'.
print_input : keyword
keyword to indicate that the list of all model stress package information will
be written to the listing file immediately after it is read.
print_flows : keyword
keyword to indicate that the list of all model package 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 all model package flow terms will be written to the
file specified with 'budget fileout' in output control.
nc_mesh2d_filerecord : record
netcdf layered mesh fileout record.
nc_structured_filerecord : record
netcdf structured fileout record.
nc_filerecord : record
netcdf filerecord
packages : list
filename : str
File name for this package.
pname : str
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.
"""
super().__init__(model, "nam", filename, pname, loading_package, **kwargs)
self.list = self.build_mfdata("list", list)
self.print_input = self.build_mfdata("print_input", print_input)
self.print_flows = self.build_mfdata("print_flows", print_flows)
self.save_flows = self.build_mfdata("save_flows", save_flows)
self.nc_mesh2d_filerecord = self.build_mfdata(
"nc_mesh2d_filerecord", nc_mesh2d_filerecord
)
self.nc_structured_filerecord = self.build_mfdata(
"nc_structured_filerecord", nc_structured_filerecord
)
self.nc_filerecord = self.build_mfdata("nc_filerecord", nc_filerecord)
self.packages = self.build_mfdata("packages", packages)
self._init_complete = True