fix(flopy interface change): updated dfn files and test cases to work with flopy's new interface (MODFLOW-ORG#933)

spaulins-usgs · Hofer-Julian · commit 0d57439592be · 2022-07-15T09:05:10.000+02:00
* feat(dfn): Move information from flopy.dfn into the header of the package dfns.

* fix(test cases): test cases changed to work with new flopy interface

* testing

* remove test
diff --git a/autotest/test_gwf_ats01.py b/autotest/test_gwf_ats01.py
@@ -70,23 +70,24 @@ def build_model(idx, dir):
 
     # create tdis package
     ats_filerecord = None
-    if True:
-        atsperiod = [
-            (0, dt0, dtmin, dtmax, dtadj, dtfailadj),
-            (7, dt0, dtmin, dtmax, dtadj, dtfailadj),
-        ]
-        ats = flopy.mf6.ModflowUtlats(
-            sim, maxats=len(atsperiod), perioddata=atsperiod
-        )
-        ats_filerecord = name + ".ats"
-
     tdis = flopy.mf6.ModflowTdis(
         sim,
         ats_filerecord=ats_filerecord,
         time_units="DAYS",
         nper=nper,
         perioddata=tdis_rc,
     )
+    if True:
+        ats_filerecord = name + ".ats"
+        atsperiod = [
+            (0, dt0, dtmin, dtmax, dtadj, dtfailadj),
+            (7, dt0, dtmin, dtmax, dtadj, dtfailadj),
+        ]
+        tdis.ats.initialize(
+            maxats=len(atsperiod),
+            perioddata=atsperiod,
+            filename=ats_filerecord,
+        )
 
     # create gwf model
     gwfname = name
diff --git a/autotest/test_gwf_ats02.py b/autotest/test_gwf_ats02.py
@@ -70,24 +70,24 @@ def build_model(idx, dir):
     )
 
     # create tdis package
-    ats_filerecord = None
-    if True:
-        atsperiod = [
-            (i, dt0, dtmin, dtmax, dtadj, dtfailadj) for i in range(nper)
-        ]
-        ats = flopy.mf6.ModflowUtlats(
-            sim, maxats=len(atsperiod), perioddata=atsperiod
-        )
-        ats_filerecord = name + ".ats"
-
     tdis = flopy.mf6.ModflowTdis(
         sim,
-        ats_filerecord=ats_filerecord,
         time_units="DAYS",
         nper=nper,
         perioddata=tdis_rc,
     )
 
+    if True:
+        ats_filerecord = name + ".ats"
+        atsperiod = [
+            (i, dt0, dtmin, dtmax, dtadj, dtfailadj) for i in range(nper)
+        ]
+        tdis.ats.initialize(
+            maxats=len(atsperiod),
+            perioddata=atsperiod,
+            filename=ats_filerecord,
+        )
+
     # create gwf model
     gwfname = name
     #        newtonoptions = "NEWTON UNDER_RELAXATION"
diff --git a/autotest/test_gwf_ats03.py b/autotest/test_gwf_ats03.py
@@ -75,21 +75,20 @@ def build_model(idx, dir):
     dtmax = 100.0
     dtadj = 2.0
     dtfailadj = 5.0
-    ats_filerecord = None
-    if True:
-        atsperiod = [(0, dt0, dtmin, dtmax, dtadj, dtfailadj)]
-        ats = flopy.mf6.ModflowUtlats(
-            sim, maxats=len(atsperiod), perioddata=atsperiod
-        )
-        ats_filerecord = name + ".ats"
-
     tdis = flopy.mf6.ModflowTdis(
         sim,
-        ats_filerecord=ats_filerecord,
         time_units="DAYS",
         nper=nper,
         perioddata=tdis_rc,
     )
+    if True:
+        ats_filerecord = name + ".ats"
+        atsperiod = [(0, dt0, dtmin, dtmax, dtadj, dtfailadj)]
+        tdis.ats.initialize(
+            maxats=len(atsperiod),
+            perioddata=atsperiod,
+            filename=ats_filerecord,
+        )
 
     # create gwf model
     gwfname = name
diff --git a/autotest/test_gwf_ats_lak01.py b/autotest/test_gwf_ats_lak01.py
@@ -75,26 +75,27 @@ def build_model(idx, dir):
     dtmax = 10.0
     dtadj = 2.0
     dtfailadj = 5.0
-    ats_filerecord = None
-    if True:
-        atsperiod = [
-            (0, dt0, dtmin, dtmax, dtadj, dtfailadj),
-            (7, dt0, dtmin, dtmax, dtadj, dtfailadj),
-        ]
-        ats = flopy.mf6.ModflowUtlats(
-            sim, maxats=len(atsperiod), perioddata=atsperiod
-        )
-        ats_filerecord = name + ".ats"
 
     # create tdis package
     tdis = flopy.mf6.ModflowTdis(
         sim,
-        ats_filerecord=ats_filerecord,
         time_units="DAYS",
         nper=nper,
         perioddata=tdis_rc,
     )
 
+    if True:
+        ats_filerecord = name + ".ats"
+        atsperiod = [
+            (0, dt0, dtmin, dtmax, dtadj, dtfailadj),
+            (7, dt0, dtmin, dtmax, dtadj, dtfailadj),
+        ]
+        tdis.ats.initialize(
+            maxats=len(atsperiod),
+            perioddata=atsperiod,
+            filename=ats_filerecord,
+        )
+
     # create gwf model
     gwfname = name
     global gwf
diff --git a/autotest/test_gwf_multimvr.py b/autotest/test_gwf_multimvr.py
@@ -838,7 +838,6 @@ def instantiate_base_simulation(sim_ws, gwfname, gwfnamec):
         exgmnameb=gwfnamec,
         nexg=len(exchange_data),
         exchangedata=exchange_data,
-        mvr_filerecord="{}.mvr".format(name),
         pname="EXG-1",
         filename="{}.exg".format(name),
     )
@@ -977,8 +976,8 @@ def add_sim_mvr(sim, gwfname, gwfnamec, remaining_frac=None):
 
     mvrspd = {0: sim_mvr_perioddata}
     maxmvr = 3
-    mvr = flopy.mf6.ModflowMvr(
-        sim,
+    gwfgwf = sim.get_exchange_file("gwf.exg")
+    gwfgwf.mvr.initialize(
         modelnames=True,
         maxmvr=maxmvr,
         print_flows=True,
diff --git a/autotest/test_gwf_npf03_sfr.py b/autotest/test_gwf_npf03_sfr.py
@@ -147,7 +147,6 @@ def build_model(idx, dir):
         excf = flopy.mf6.ModflowGwfgwf(
             sim,
             exgtype="GWF6-GWF6",
-            mvr_filerecord=fnmvr,
             nexg=len(exchd),
             exgmnamea=mnames[0],
             exgmnameb=mnames[1],
@@ -179,7 +178,7 @@ def build_model(idx, dir):
         )
         # create mvr package
         mmvr = flopy.mf6.ModflowMvr(
-            sim,
+            excf,
             print_input=True,
             modelnames=True,
             maxmvr=len(mvrpd),
diff --git a/autotest/test_gwf_npf_tvk01.py b/autotest/test_gwf_npf_tvk01.py
@@ -120,7 +120,6 @@ def build_model(idx, dir):
         icelltype=laytyp,
         k=hk,
         k33=hk,
-        tvk_filerecord=[tvk_filename],
     )
 
     # tvk
@@ -134,7 +133,7 @@ def build_model(idx, dir):
                     spd.append([(k, i, j), "K", hydraulic_conductivity])
         tvkspd[kper] = spd
     tvk = flopy.mf6.ModflowUtltvk(
-        gwf, print_input=True, perioddata=tvkspd, filename=tvk_filename
+        npf, print_input=True, perioddata=tvkspd, filename=tvk_filename
     )
 
     # chd files
diff --git a/autotest/test_gwf_npf_tvk02.py b/autotest/test_gwf_npf_tvk02.py
@@ -114,9 +114,7 @@ def build_model(idx, dir):
 
     # node property flow
     tvk_filename = f"{gwfname}.npf.tvk"
-    npf = flopy.mf6.ModflowGwfnpf(
-        gwf, icelltype=laytyp, k=hk, k33=hk, tvk_filerecord=[tvk_filename]
-    )
+    npf = flopy.mf6.ModflowGwfnpf(gwf, icelltype=laytyp, k=hk, k33=hk)
 
     # TVK
     tvkspd = {}
@@ -157,7 +155,7 @@ def build_model(idx, dir):
     tvkspd[kper - 1] = spd
 
     tvk = flopy.mf6.ModflowUtltvk(
-        gwf, print_input=True, perioddata=tvkspd, filename=tvk_filename
+        npf, print_input=True, perioddata=tvkspd, filename=tvk_filename
     )
 
     # chd files
diff --git a/autotest/test_gwf_npf_tvk03.py b/autotest/test_gwf_npf_tvk03.py
@@ -114,9 +114,7 @@ def build_model(idx, dir):
 
     # node property flow
     tvk_filename = f"{gwfname}.npf.tvk"
-    npf = flopy.mf6.ModflowGwfnpf(
-        gwf, icelltype=laytyp, k=hk, k33=hk, tvk_filerecord=[tvk_filename]
-    )
+    npf = flopy.mf6.ModflowGwfnpf(gwf, icelltype=laytyp, k=hk, k33=hk)
 
     # TVK
     tvkspd = {}
@@ -157,7 +155,7 @@ def build_model(idx, dir):
     tvkspd[kper - 1] = spd
 
     tvk = flopy.mf6.ModflowUtltvk(
-        gwf, print_input=True, perioddata=tvkspd, filename=tvk_filename
+        npf, print_input=True, perioddata=tvkspd, filename=tvk_filename
     )
 
     # chd files
diff --git a/autotest/test_gwf_sto_tvs01.py b/autotest/test_gwf_sto_tvs01.py
@@ -138,7 +138,6 @@ def build_model(idx, dir):
         ss=ss,
         sy=sy,
         transient=transient,
-        tvs_filerecord=[tvs_filename],
     )
 
     # TVS
@@ -172,7 +171,7 @@ def build_model(idx, dir):
     tvsspd[kper - 1] = spd
 
     tvs = flopy.mf6.ModflowUtltvs(
-        gwf, print_input=True, perioddata=tvsspd, filename=tvs_filename
+        sto, print_input=True, perioddata=tvsspd, filename=tvs_filename
     )
 
     # output control
diff --git a/autotest/test_gwt_prudic2004t2fmiats.py b/autotest/test_gwt_prudic2004t2fmiats.py
@@ -465,30 +465,30 @@ def run_transport_model():
         continue_=False,
     )
 
-    ats_filerecord = None
+    tdis_rc = [(1.0, 1, 1.0), (365.25 * 25, 25, 1.0)]
+    nper = len(tdis_rc)
+    tdis = flopy.mf6.ModflowTdis(
+        sim,
+        time_units="DAYS",
+        nper=nper,
+        perioddata=tdis_rc,
+    )
+
     if True:
         dt0 = 100
         dtmin = 1.0e-5
         dtmax = 10000.0
         dtadj = 2.0
         dtfailadj = 5.0
+        ats_filerecord = name + ".ats"
         atsperiod = [
             (1, dt0, dtmin, dtmax, dtadj, dtfailadj),
         ]
-        ats = flopy.mf6.ModflowUtlats(
-            sim, maxats=len(atsperiod), perioddata=atsperiod
+        tdis.ats.initialize(
+            maxats=len(atsperiod),
+            perioddata=atsperiod,
+            filename=ats_filerecord,
         )
-        ats_filerecord = name + ".ats"
-
-    tdis_rc = [(1.0, 1, 1.0), (365.25 * 25, 25, 1.0)]
-    nper = len(tdis_rc)
-    tdis = flopy.mf6.ModflowTdis(
-        sim,
-        time_units="DAYS",
-        nper=nper,
-        perioddata=tdis_rc,
-        ats_filerecord=ats_filerecord,
-    )
 
     gwt = flopy.mf6.ModflowGwt(sim, modelname=gwtname)
 
diff --git a/autotest/test_gwt_prudic2004t2gwtgwt.py b/autotest/test_gwt_prudic2004t2gwtgwt.py
@@ -195,9 +195,6 @@ def build_model(idx, ws):
                 gwfgwf_data.append(connection)
 
     # GWF-GWF
-    mvr_filerecord = None
-    if across_model_mvr_on:
-        mvr_filerecord = f"{name}.gwfgwf.mvr"
     gwfgwf = flopy.mf6.ModflowGwfgwf(
         sim,
         exgtype="GWF6-GWF6",
@@ -206,7 +203,6 @@ def build_model(idx, ws):
         exgmnameb=gwfnames[1],  # south
         exchangedata=gwfgwf_data,
         auxiliary=["ANGLDEGX", "CDIST"],
-        mvr_filerecord=mvr_filerecord,
         dev_interfacemodel_on=False,
     )
 
@@ -215,21 +211,18 @@ def build_model(idx, ws):
         maxmvr, maxpackages = 1, 2
         mvrpack_sim = [["flow1", "lak-1"], ["flow2", "sfr-2"]]
         mvrspd = [["flow1", "lak-1", 0, "flow2", "sfr-2", 0, "FACTOR", 1.00]]
-        mvr = flopy.mf6.ModflowMvr(
-            sim,
+        mvr_filerecord = f"{name}.gwfgwf.mvr"
+        gwfgwf.mvr.initialize(
             modelnames=True,
             maxmvr=maxmvr,
             print_flows=True,
             maxpackages=maxpackages,
             packages=mvrpack_sim,
             perioddata=mvrspd,
-            filename=f"{name}.gwfgwf.mvr",
+            filename=mvr_filerecord,
         )
 
     # GWT-GWT
-    mvt_filerecord = None
-    if across_model_mvt_on:
-        mvt_filerecord = f"{name}.gwtgwt.mvt"
     gwtgwt = flopy.mf6.ModflowGwtgwt(
         sim,
         exgtype="GWT6-GWT6",
@@ -240,15 +233,13 @@ def build_model(idx, ws):
         gwfmodelname2=gwfnames[1],
         exchangedata=gwfgwf_data,
         auxiliary=["ANGLDEGX", "CDIST"],
-        mvt_filerecord=mvt_filerecord,
         # dev_interfacemodel_on=False,
     )
 
     # simulation GWT-GWT Mover
     if across_model_mvt_on:
-        mvt = flopy.mf6.modflow.ModflowGwtmvt(
-            sim, filename=f"{name}.gwtgwt.mvt"
-        )
+        mvt_filerecord = f"{name}.gwtgwt.mvt"
+        gwtgwt.mvt.initialize(filename=f"{name}.gwtgwt.mvt")
 
     regression = None
     return sim, regression
diff --git a/doc/mf6io/mf6ivar/dfn/gwf-gnc.dfn b/doc/mf6io/mf6ivar/dfn/gwf-gnc.dfn
@@ -1,4 +1,6 @@
 # --------------------- gwf gnc options ---------------------
+# flopy subpackage gnc_filerecord gnc gncdata gncdata
+# flopy parent_name_type parent_model_or_package
 
 block options
 name print_input
diff --git a/doc/mf6io/mf6ivar/dfn/gwf-mvr.dfn b/doc/mf6io/mf6ivar/dfn/gwf-mvr.dfn
@@ -1,4 +1,6 @@
 # --------------------- gwf mvr options ---------------------
+# flopy subpackage mvr_filerecord mvr perioddata perioddata
+# flopy parent_name_type parent_model_or_package MFModel/MFPackage
 
 block options
 name print_input
diff --git a/doc/mf6io/mf6ivar/dfn/gwt-mvt.dfn b/doc/mf6io/mf6ivar/dfn/gwt-mvt.dfn
@@ -1,4 +1,6 @@
 # --------------------- gwt mvt options ---------------------
+# flopy subpackage mvt_filerecord mvt perioddata perioddata
+# flopy parent_name_type parent_model_or_package MFModel/MFPackage
 
 block options
 name print_input
diff --git a/doc/mf6io/mf6ivar/dfn/utl-ats.dfn b/doc/mf6io/mf6ivar/dfn/utl-ats.dfn
@@ -1,5 +1,6 @@
 # --------------------- sim ats options ---------------------
-
+# flopy subpackage ats_filerecord ats perioddata ats_perioddata
+# flopy parent_name_type parent_package MFPackage
 
 # --------------------- sim ats dimensions ---------------------
 
diff --git a/doc/mf6io/mf6ivar/dfn/utl-laktab.dfn b/doc/mf6io/mf6ivar/dfn/utl-laktab.dfn
@@ -1,4 +1,5 @@
 # --------------------- gwf laktab dimensions ---------------------
+# flopy multi-package
 
 block dimensions
 name nrow
diff --git a/doc/mf6io/mf6ivar/dfn/utl-obs.dfn b/doc/mf6io/mf6ivar/dfn/utl-obs.dfn
@@ -1,5 +1,7 @@
 # --------------------- gwf obs options ---------------------
 # flopy multi-package
+# flopy subpackage obs_filerecord obs continuous observations
+# flopy parent_name_type parent_model_or_package MFModel/MFPackage
 
 block options
 name digits
diff --git a/doc/mf6io/mf6ivar/dfn/utl-sfrtab.dfn b/doc/mf6io/mf6ivar/dfn/utl-sfrtab.dfn
diff --git a/doc/mf6io/mf6ivar/dfn/utl-tas.dfn b/doc/mf6io/mf6ivar/dfn/utl-tas.dfn
diff --git a/doc/mf6io/mf6ivar/dfn/utl-ts.dfn b/doc/mf6io/mf6ivar/dfn/utl-ts.dfn
diff --git a/doc/mf6io/mf6ivar/dfn/utl-tvk.dfn b/doc/mf6io/mf6ivar/dfn/utl-tvk.dfn
diff --git a/doc/mf6io/mf6ivar/dfn/utl-tvs.dfn b/doc/mf6io/mf6ivar/dfn/utl-tvs.dfn
diff --git a/doc/mf6io/mf6ivar/readme.md b/doc/mf6io/mf6ivar/readme.md

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,6 @@ def build_model(idx, dir):`
`120`	`120`	`icelltype=laytyp,`
`121`	`121`	`k=hk,`
`122`	`122`	`k33=hk,`
`123`		`- tvk_filerecord=[tvk_filename],`
`124`	`123`	`)`
`125`	`124`
`126`	`125`	`# tvk`
`@@ -134,7 +133,7 @@ def build_model(idx, dir):`
`134`	`133`	`spd.append([(k, i, j), "K", hydraulic_conductivity])`
`135`	`134`	`tvkspd[kper] = spd`
`136`	`135`	`tvk = flopy.mf6.ModflowUtltvk(`
`137`		`- gwf, print_input=True, perioddata=tvkspd, filename=tvk_filename`
	`136`	`+ npf, print_input=True, perioddata=tvkspd, filename=tvk_filename`
`138`	`137`	`)`
`139`	`138`
`140`	`139`	`# chd files`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,6 @@ def build_model(idx, dir):`
`138`	`138`	`ss=ss,`
`139`	`139`	`sy=sy,`
`140`	`140`	`transient=transient,`
`141`		`- tvs_filerecord=[tvs_filename],`
`142`	`141`	`)`
`143`	`142`
`144`	`143`	`# TVS`
`@@ -172,7 +171,7 @@ def build_model(idx, dir):`
`172`	`171`	`tvsspd[kper - 1] = spd`
`173`	`172`
`174`	`173`	`tvs = flopy.mf6.ModflowUtltvs(`
`175`		`- gwf, print_input=True, perioddata=tvsspd, filename=tvs_filename`
	`174`	`+ sto, print_input=True, perioddata=tvsspd, filename=tvs_filename`
`176`	`175`	`)`
`177`	`176`
`178`	`177`	`# output control`