from ..pakbase import Package
[docs]class ModflowPbc(Package):
"""
Periodic boundary condition class
"""
def __init__(
self,
model,
layer_row_column_data=None,
layer_row_column_shead_ehead=None,
cosines=None,
extension="pbc",
unitnumber=None,
zerobase=True,
):
# set default unit number of one is not specified
if unitnumber is None:
unitnumber = ModflowPbc._defaultunit()
# call base package constructor
super().__init__(model, extension, self._ftype(), unitnumber)
self._generate_heading()
self.mxactp = 0
if layer_row_column_data is None:
if layer_row_column_shead_ehead is not None:
print(
"\nWARNING: ModflowPbc - Do not use "
"layer_row_column_shead_ehead!\n"
+ 22 * " "
+ "Use layer_row_column_data instead."
)
layer_row_column_data = layer_row_column_shead_ehead
else:
raise Exception(
"Failed to specify layer_row_column_shead_ehead "
"or layer_row_column_data."
)
(self.mxactp, self.layer_row_column_data) = self.assign_layer_row_column_data(
layer_row_column_data, 5, zerobase=zerobase
)
# misuse of this function - zerobase needs to be False
self.mxcos, self.cosines = self.assign_layer_row_column_data(
cosines, 3, zerobase=False
)
self.np = 0
self.parent.add_package(self)
def _ncells(self):
"""Maximum number of cells that have pbc boundaries (developed for
MT3DMS SSM package).
Returns
-------
ncells: int
maximum number of pbc cells
"""
return self.mxactp
[docs] def write_file(self):
"""
Write the package file.
Returns
-------
None
"""
f_pbc = open(self.fn_path, "w")
f_pbc.write(f"{self.heading}\n")
f_pbc.write("%10i%10i\n" % (self.mxactp, self.mxcos))
for n in range(self.parent.get_package("DIS").nper):
if n < len(self.layer_row_column_data):
a = self.layer_row_column_data[n]
itmp = a.shape[0]
else:
itmp = -1
if n < len(self.cosines):
c = self.cosines[n]
ctmp = c.shape[0]
else:
ctmp = -1
f_pbc.write(f"{itmp:10d}{ctmp:10d}{self.np:10d}\n")
if n < len(self.layer_row_column_data):
for b in a:
f_pbc.write(f"{b[0]:10d}{b[1]:10d}{b[2]:10d}{b[3]:10d}{b[4]:10d}\n")
if n < len(self.cosines):
for d in c:
f_pbc.write(f"{d[0]:10g}{d[1]:10g}{d[2]:10g}\n")
f_pbc.close()
@staticmethod
def _ftype():
return "PBC"
@staticmethod
def _defaultunit():
return 30