Gael-de-Sailly
/
flopy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(package write): Allow user to define and write empty stress period blocks to package files (#1091) (#1093) 

* fix(package write): Allow user to define and write empty stress period blocks to package files (#1091)

* fix(package write): Added tests for code allowing user to define and write empty stress period blocks to package files (#1091)

* fix(formatting): formatting with latest version of black not accepted. using previously version

Co-authored-by: Scott Paulinski <spaulinski@usgs.gov>
develop
scottrp 2021-04-08 14:28:58 -07:00 committed by GitHub
parent 19bc25ead4
commit 58cb48e7a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 225 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

314
autotest/t505_test.py
View File

@ -250,14 +250,14 @@ def np001():
model,
budget_filerecord=[("np001_mod.cbc",)],
head_filerecord=[("np001_mod.hds",)],
saverecord={
0: [("HEAD", "ALL"), ("BUDGET", "ALL")],
1: [("HEAD", "ALL"), ("BUDGET", "ALL")],
},
printrecord=[("HEAD", "ALL"), ("BUDGET", "ALL")],
saverecord={0: [("HEAD", "ALL"), ("BUDGET", "ALL")], 1: [],},
printrecord=[("HEAD", "ALL")],
)
empty_sp_text = oc_package.saverecord.get_file_entry(1)
assert empty_sp_text == ""
oc_package.printrecord.add_transient_key(1)
oc_package.printrecord.set_data([("HEAD", "ALL"), ("BUDGET", "ALL")], 1)
oc_package.saverecord.set_data([("HEAD", "ALL"), ("BUDGET", "ALL")], 1)
sto_package = ModflowGwfsto(
model, save_flows=True, iconvert=1, ss=0.000001, sy=0.15
@ -511,6 +511,54 @@ def np001():
found_cellid = True
assert found_cellid
# test empty stress period
well_spd = {0: [(-1, -1, -1, -2000.0), (0, 0, 7, -2.0)], 1: []}
wel_package = ModflowGwfwel(
model,
print_input=True,
print_flows=True,
save_flows=True,
maxbound=2,
stress_period_data=well_spd,
)
wel_package.write()
found_begin = False
found_end = False
text_between_begin_and_end = False
with open(os.path.join(mpath, "np001_mod.wel"), "r") as fd:
for line in fd:
if line.strip().lower() == "begin period 2":
found_begin = True
elif found_begin and not found_end:
if line.strip().lower() == "end period 2":
found_end = True
else:
if len(line.strip()) > 0:
text_between_begin_and_end = True
assert found_begin and found_end and not text_between_begin_and_end
# test loading and re-writing empty stress period
test_sim = MFSimulation.load(
test_ex_name, "mf6", exe_name, run_folder, write_headers=False,
)
wel = test_sim.get_model().wel
wel._filename = "np001_spd_test.wel"
wel.write()
found_begin = False
found_end = False
text_between_begin_and_end = False
with open(os.path.join(mpath, "np001_spd_test.wel"), "r") as fd:
for line in fd:
if line.strip().lower() == "begin period 2":
found_begin = True
elif found_begin and not found_end:
if line.strip().lower() == "end period 2":
found_end = True
else:
if len(line.strip()) > 0:
text_between_begin_and_end = True
assert found_begin and found_end and not text_between_begin_and_end
return
@ -739,26 +787,26 @@ def np002():
# check case where aux variable defined and stress period data has empty
# stress period
model.remove_package('ghb')
model.remove_package("ghb")
ghb_package = ModflowGwfghb(
model,
print_input=True,
print_flows=True,
maxbound=1,
stress_period_data={0:[((0, 0, 9), 125.0, 60.0, 0.0)], 1:[()]},
auxiliary=["CONCENTRATION"]
stress_period_data={0: [((0, 0, 9), 125.0, 60.0, 0.0)], 1: [()]},
auxiliary=["CONCENTRATION"],
)
sim.write_simulation()
sim2 = MFSimulation.load(
sim_name=test_ex_name,
version="mf6",
exe_name=exe_name,
sim_ws=run_folder
sim_ws=run_folder,
)
md2 = sim2.get_model()
ghb2 = md2.get_package('ghb')
ghb2 = md2.get_package("ghb")
spd2 = ghb2.stress_period_data.get_data(1)
assert(spd2 is None)
assert spd2 is None
return
@ -1310,15 +1358,7 @@ def test005_advgw_tidal():
("rv2-upper", "RIV", "riv2_upper"),
("rv-2-7-4", "RIV", (0, 6, 3)),
("rv2-8-5", "RIV", (0, 6, 4)),
(
"rv-2-9-6",
"RIV",
(
0,
5,
5,
),
),
("rv-2-9-6", "RIV", (0, 5, 5,),),
],
"riv_flowsA.csv": [
("riv1-3-1", "RIV", (0, 2, 0)),
@ -2886,20 +2926,20 @@ def test_transport():
expected_head_file = os.path.join(expected_output_folder, "gwf_mst03.hds")
expected_conc_file = os.path.join(expected_output_folder, "gwt_mst03.unc")
ws = os.path.join('temp', 't505', test_ex_name)
ws = os.path.join("temp", "t505", test_ex_name)
laytyp = [1]
ss = [1.e-10]
ss = [1.0e-10]
sy = [0.1]
nlay, nrow, ncol = 1, 1, 1
nper = 2
perlen = [2., 2.]
perlen = [2.0, 2.0]
nstp = [14, 14]
tsmult = [1., 1.]
delr = 10.
delc = 10.
top = 10.
botm = [0.]
tsmult = [1.0, 1.0]
delr = 10.0
delc = 10.0
top = 10.0
botm = [0.0]
strt = top
hk = 1.0
@ -2912,129 +2952,171 @@ def test_transport():
idx = 0
# build MODFLOW 6 files
sim = flopy.mf6.MFSimulation(sim_name=name, version='mf6',
exe_name='mf6',
sim_ws=ws)
sim = flopy.mf6.MFSimulation(
sim_name=name, version="mf6", exe_name="mf6", sim_ws=ws
)
# create tdis package
tdis = flopy.mf6.ModflowTdis(sim, time_units='DAYS',
nper=nper, perioddata=tdis_rc)
tdis = flopy.mf6.ModflowTdis(
sim, time_units="DAYS", nper=nper, perioddata=tdis_rc
)
# create gwf model
gwfname = 'gwf_' + name
newtonoptions = ['NEWTON', 'UNDER_RELAXATION']
gwf = flopy.mf6.ModflowGwf(sim, modelname=gwfname,
newtonoptions=newtonoptions,)
gwfname = "gwf_" + name
newtonoptions = ["NEWTON", "UNDER_RELAXATION"]
gwf = flopy.mf6.ModflowGwf(
sim, modelname=gwfname, newtonoptions=newtonoptions,
)
# create iterative model solution and register the gwf model with it
imsgwf = flopy.mf6.ModflowIms(sim, print_option='SUMMARY',
outer_dvclose=hclose,
outer_maximum=nouter,
under_relaxation='DBD',
under_relaxation_theta=0.7,
inner_maximum=ninner,
inner_dvclose=hclose, rcloserecord=rclose,
linear_acceleration='BICGSTAB',
scaling_method='NONE',
reordering_method='NONE',
relaxation_factor=relax,
filename='{}.ims'.format(gwfname))
imsgwf = flopy.mf6.ModflowIms(
sim,
print_option="SUMMARY",
outer_dvclose=hclose,
outer_maximum=nouter,
under_relaxation="DBD",
under_relaxation_theta=0.7,
inner_maximum=ninner,
inner_dvclose=hclose,
rcloserecord=rclose,
linear_acceleration="BICGSTAB",
scaling_method="NONE",
reordering_method="NONE",
relaxation_factor=relax,
filename="{}.ims".format(gwfname),
)
sim.register_ims_package(imsgwf, [gwf.name])
dis = flopy.mf6.ModflowGwfdis(gwf, nlay=nlay, nrow=nrow, ncol=ncol,
delr=delr, delc=delc,
top=top, botm=botm,
idomain=np.ones((nlay, nrow, ncol),
dtype=int))
dis = flopy.mf6.ModflowGwfdis(
gwf,
nlay=nlay,
nrow=nrow,
ncol=ncol,
delr=delr,
delc=delc,
top=top,
botm=botm,
idomain=np.ones((nlay, nrow, ncol), dtype=int),
)
# initial conditions
ic = flopy.mf6.ModflowGwfic(gwf, strt=strt)
# node property flow
npf = flopy.mf6.ModflowGwfnpf(gwf, save_flows=False,
icelltype=laytyp[idx],
k=hk, k33=hk)
npf = flopy.mf6.ModflowGwfnpf(
gwf, save_flows=False, icelltype=laytyp[idx], k=hk, k33=hk
)
# storage
sto = flopy.mf6.ModflowGwfsto(gwf, save_flows=False,
iconvert=laytyp[idx],
ss=ss[idx], sy=sy[idx],
steady_state={0: False},
transient={0: True})
sto = flopy.mf6.ModflowGwfsto(
gwf,
save_flows=False,
iconvert=laytyp[idx],
ss=ss[idx],
sy=sy[idx],
steady_state={0: False},
transient={0: True},
)
# wel files
welspdict = {0: [[(0, 0, 0), -25., 0.]],
1: [[(0, 0, 0), 25., 0.]]}
wel = flopy.mf6.ModflowGwfwel(gwf, print_input=True, print_flows=True,
stress_period_data=welspdict,
save_flows=False,
auxiliary='CONCENTRATION', pname='WEL-1')
welspdict = {0: [[(0, 0, 0), -25.0, 0.0]], 1: [[(0, 0, 0), 25.0, 0.0]]}
wel = flopy.mf6.ModflowGwfwel(
gwf,
print_input=True,
print_flows=True,
stress_period_data=welspdict,
save_flows=False,
auxiliary="CONCENTRATION",
pname="WEL-1",
)
# output control
oc = flopy.mf6.ModflowGwfoc(gwf,
budget_filerecord='{}.cbc'.format(gwfname),
head_filerecord='{}.hds'.format(gwfname),
headprintrecord=[
('COLUMNS', 10, 'WIDTH', 15,
'DIGITS', 6, 'GENERAL')],
saverecord=[('HEAD', 'ALL')],
printrecord=[('HEAD', 'ALL'),
('BUDGET', 'ALL')])
oc = flopy.mf6.ModflowGwfoc(
gwf,
budget_filerecord="{}.cbc".format(gwfname),
head_filerecord="{}.hds".format(gwfname),
headprintrecord=[("COLUMNS", 10, "WIDTH", 15, "DIGITS", 6, "GENERAL")],
saverecord=[("HEAD", "ALL")],
printrecord=[("HEAD", "ALL"), ("BUDGET", "ALL")],
)
# create gwt model
gwtname = 'gwt_' + name
gwt = flopy.mf6.MFModel(sim, model_type='gwt6', modelname=gwtname,
model_nam_file='{}.nam'.format(gwtname))
gwtname = "gwt_" + name
gwt = flopy.mf6.MFModel(
sim,
model_type="gwt6",
modelname=gwtname,
model_nam_file="{}.nam".format(gwtname),
)
# create iterative model solution and register the gwt model with it
imsgwt = flopy.mf6.ModflowIms(sim, print_option='SUMMARY',
outer_dvclose=hclose,
outer_maximum=nouter,
under_relaxation='NONE',
inner_maximum=ninner,
inner_dvclose=hclose, rcloserecord=rclose,
linear_acceleration='BICGSTAB',
scaling_method='NONE',
reordering_method='NONE',
relaxation_factor=relax,
filename='{}.ims'.format(gwtname))
imsgwt = flopy.mf6.ModflowIms(
sim,
print_option="SUMMARY",
outer_dvclose=hclose,
outer_maximum=nouter,
under_relaxation="NONE",
inner_maximum=ninner,
inner_dvclose=hclose,
rcloserecord=rclose,
linear_acceleration="BICGSTAB",
scaling_method="NONE",
reordering_method="NONE",
relaxation_factor=relax,
filename="{}.ims".format(gwtname),
)
sim.register_ims_package(imsgwt, [gwt.name])
dis = flopy.mf6.ModflowGwtdis(gwt, nlay=nlay, nrow=nrow, ncol=ncol,
delr=delr, delc=delc,
top=top, botm=botm,
idomain=1,
filename='{}.dis'.format(gwtname))
dis = flopy.mf6.ModflowGwtdis(
gwt,
nlay=nlay,
nrow=nrow,
ncol=ncol,
delr=delr,
delc=delc,
top=top,
botm=botm,
idomain=1,
filename="{}.dis".format(gwtname),
)
# initial conditions
ic = flopy.mf6.ModflowGwtic(gwt, strt=100.)
ic = flopy.mf6.ModflowGwtic(gwt, strt=100.0)
# advection
adv = flopy.mf6.ModflowGwtadv(gwt, scheme='UPSTREAM',
filename='{}.adv'.format(gwtname))
adv = flopy.mf6.ModflowGwtadv(
gwt, scheme="UPSTREAM", filename="{}.adv".format(gwtname)
)
# mass storage and transfer
mst = flopy.mf6.ModflowGwtmst(gwt, porosity=sy[idx],
filename='{}.mst'.format(gwtname))
mst = flopy.mf6.ModflowGwtmst(
gwt, porosity=sy[idx], filename="{}.mst".format(gwtname)
)
# sources
sourcerecarray = [('WEL-1', 'AUX', 'CONCENTRATION')]
ssm = flopy.mf6.ModflowGwtssm(gwt, sources=sourcerecarray,
filename='{}.ssm'.format(gwtname))
sourcerecarray = [("WEL-1", "AUX", "CONCENTRATION")]
ssm = flopy.mf6.ModflowGwtssm(
gwt, sources=sourcerecarray, filename="{}.ssm".format(gwtname)
)
# output control
oc = flopy.mf6.ModflowGwtoc(gwt,
budget_filerecord='{}.cbc'.format(gwtname),
concentration_filerecord='{}.ucn'.format(gwtname),
concentrationprintrecord=[
('COLUMNS', 10, 'WIDTH', 15,
'DIGITS', 6, 'GENERAL')],
saverecord=[('CONCENTRATION', 'ALL')],
printrecord=[('CONCENTRATION', 'ALL'),
('BUDGET', 'ALL')])
oc = flopy.mf6.ModflowGwtoc(
gwt,
budget_filerecord="{}.cbc".format(gwtname),
concentration_filerecord="{}.ucn".format(gwtname),
concentrationprintrecord=[
("COLUMNS", 10, "WIDTH", 15, "DIGITS", 6, "GENERAL")
],
saverecord=[("CONCENTRATION", "ALL")],
printrecord=[("CONCENTRATION", "ALL"), ("BUDGET", "ALL")],
)
# GWF GWT exchange
gwfgwt = flopy.mf6.ModflowGwfgwt(sim, exgtype='GWF6-GWT6',
exgmnamea=gwfname, exgmnameb=gwtname,
filename='{}.gwfgwt'.format(name))
gwfgwt = flopy.mf6.ModflowGwfgwt(
sim,
exgtype="GWF6-GWT6",
exgmnamea=gwfname,
exgmnameb=gwtname,
filename="{}.gwfgwt".format(name),
)
# write MODFLOW 6 files
sim.write_simulation()

29
flopy/mf6/data/mfdatalist.py
View File

@ -389,6 +389,10 @@ class MFList(mfdata.MFMultiDimVar, DataListInterface):
data_check = None
else:
data_check = data
if data_check is None or (
isinstance(data_check, list) and len(data_check) == 0
):
check_data = False
if iterable(data_check) and check_data:
# verify data length
min_line_size = self._get_min_record_entries(data)
@ -1321,6 +1325,7 @@ class MFTransientList(MFList, mfdata.MFTransient, DataListInterface):
)
self._transient_setup(self._data_storage)
self.repeating = True
self.empty_keys = {}
@property
def data_type(self):
@ -1513,12 +1518,17 @@ class MFTransientList(MFList, mfdata.MFTransient, DataListInterface):
if list_item is None:
self.remove_transient_key(key)
del_keys.append(key)
self.empty_keys[key] = False
elif isinstance(list_item, list) and len(list_item) == 0:
self.empty_keys[key] = True
else:
self.empty_keys[key] = False
self._set_data_prep(list_item, key)
super().set_data(list_item, autofill=autofill)
for key in del_keys:
del data[key]
else:
self.empty_keys[key] = False
self._set_data_prep(data["data"], key)
super().set_data(data, autofill)
else:
@ -1529,17 +1539,24 @@ class MFTransientList(MFList, mfdata.MFTransient, DataListInterface):
key = data[new_key_index]
else:
key = 0
if data is None:
self.remove_transient_key(key)
if isinstance(data, list) and len(data) == 0:
self.empty_keys[key] = True
else:
self._set_data_prep(data, key)
super().set_data(data, autofill)
self.empty_keys[key] = False
if data is None:
self.remove_transient_key(key)
else:
self._set_data_prep(data, key)
super().set_data(data, autofill)
def get_file_entry(
self, key=0, ext_file_action=ExtFileAction.copy_relative_paths
):
self._get_file_entry_prep(key)
return super().get_file_entry(ext_file_action=ext_file_action)
if key in self.empty_keys and self.empty_keys[key] == True:
return ""
else:
self._get_file_entry_prep(key)
return super().get_file_entry(ext_file_action=ext_file_action)
def load(
self,

13
flopy/mf6/mfpackage.py
View File

@ -1132,6 +1132,7 @@ class MFBlock(object):
and self.structure.name.lower() != "exchanges"
and self.structure.name.lower() != "options"
and self.structure.name.lower() != "sources"
and self.structure.name.lower() != "stressperioddata"
):
return
if self.structure.repeating():
@ -1139,15 +1140,9 @@ class MFBlock(object):
for repeating_dataset in repeating_datasets:
# resolve any missing block headers
self._add_missing_block_headers(repeating_dataset)
if len(repeating_datasets) > 0:
# loop through all block headers
for block_header in self.block_headers:
# write block
self._write_block(fd, block_header, ext_file_action)
else:
# write out block
self._write_block(fd, self.block_headers[0], ext_file_action)
for block_header in self.block_headers:
# write block
self._write_block(fd, block_header, ext_file_action)
else:
self._write_block(fd, self.block_headers[0], ext_file_action)