# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY
# mf6/utils/createpackages.py
# FILE created on May 23, 2024 14:30:07 UTC
from .. import mfpackage
from ..data.mfdatautil import ArrayTemplateGenerator
[docs]class ModflowGweic(mfpackage.MFPackage):
"""
ModflowGweic defines a ic package within a gwe6 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.
export_array_ascii : boolean
* export_array_ascii (boolean) keyword that specifies input griddata
arrays should be written to layered ascii output files.
strt : [double]
* strt (double) is the initial (starting) temperature---that is, the
temperature at the beginning of the GWE Model simulation. STRT must
be specified for all GWE Model simulations. One value is read for
every model cell.
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.
"""
strt = ArrayTemplateGenerator(("gwe6", "ic", "griddata", "strt"))
package_abbr = "gweic"
_package_type = "ic"
dfn_file_name = "gwe-ic.dfn"
dfn = [
[
"header",
],
[
"block options",
"name export_array_ascii",
"type keyword",
"reader urword",
"optional true",
"mf6internal export_ascii",
],
[
"block griddata",
"name strt",
"type double precision",
"shape (nodes)",
"reader readarray",
"layered true",
"default_value 0.0",
],
]
def __init__(
self,
model,
loading_package=False,
export_array_ascii=None,
strt=0.0,
filename=None,
pname=None,
**kwargs,
):
super().__init__(
model, "ic", filename, pname, loading_package, **kwargs
)
# set up variables
self.export_array_ascii = self.build_mfdata(
"export_array_ascii", export_array_ascii
)
self.strt = self.build_mfdata("strt", strt)
self._init_complete = True