# 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 ModflowUtlhpc(MFPackage):
"""
ModflowUtlhpc defines a HPC package.
Parameters
----------
parent_package
Parent_package that this package is a part of. Package is automatically
added to parent_package when it is initialized.
loading_package : bool, default False
Do not set this parameter. It is intended for debugging and internal
processing purposes only.
print_table : keyword
keyword to indicate that the partition table will be printed to the listing
file.
dev_log_mpi : keyword
keyword to enable (extremely verbose) logging of mpi traffic to file.
partitions : [(mname, mrank)]
is the list of zero-based partition numbers.
* mname : string
is the unique model name.
* mrank : integer
is the zero-based partition number (also: MPI rank or processor id) to which
the model will be assigned.
filename : str or PathLike, optional
Name or path of file where this package is stored.
pname : str, optional
Package name.
**kwargs
Extra keywords for :class:`flopy.mf6.mfpackage.MFPackage`.
"""
partitions = ListTemplateGenerator(("hpc", "partitions", "partitions"))
package_abbr = "utlhpc"
_package_type = "hpc"
dfn_file_name = "utl-hpc.dfn"
dfn = [
["header"],
[
"block options",
"name print_table",
"type keyword",
"reader urword",
"optional true",
],
[
"block options",
"name dev_log_mpi",
"type keyword",
"reader urword",
"optional true",
],
[
"block partitions",
"name partitions",
"type recarray mname mrank",
"reader urword",
"optional true",
],
[
"block partitions",
"name mname",
"in_record true",
"type string",
"tagged false",
"reader urword",
],
[
"block partitions",
"name mrank",
"in_record true",
"type integer",
"tagged false",
"reader urword",
],
]
def __init__(
self,
parent_package,
loading_package=False,
print_table=None,
dev_log_mpi=None,
partitions=None,
filename=None,
pname=None,
**kwargs,
):
"""Initialize ModflowUtlhpc."""
super().__init__(
parent=parent_package,
package_type="hpc",
filename=filename,
pname=pname,
loading_package=loading_package,
**kwargs,
)
self.print_table = self.build_mfdata("print_table", print_table)
self.dev_log_mpi = self.build_mfdata("dev_log_mpi", dev_log_mpi)
self.partitions = self.build_mfdata("partitions", partitions)
self._init_complete = True