docs(mf6io): standardize variable name of the feature ID in the LAK &…

… LKT dfn files (#1359) Co-authored-by: langevin-usgs <[email protected]>
MODFLOW-USGS · Sep 22, 2023 · f96223d · f96223d
1 parent 9987e5e
commit f96223d
Show file tree

Hide file tree

Showing 29 changed files with 183 additions and 180 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,6 +14,7 @@ on:
       - '**.png'
       - '**.bbl'
       - '**.bib'
+      - 'doc/**'
       - 'doc/**.dat'
       - 'doc/**.ipynb'
       - 'doc/**.py'
@@ -32,6 +33,7 @@ on:
       - '**.png'
       - '**.bbl'
       - '**.bib'
+      - 'doc/**'
       - 'doc/**.dat'
       - 'doc/**.ipynb'
       - 'doc/**.py'

diff --git a/autotest/test_gwf_ats_lak01.py b/autotest/test_gwf_ats_lak01.py
@@ -152,7 +152,7 @@ def build_model(idx, dir):
             irch[i, j] = k + 1
     nlakeconn = len(lake_vconnect)
 
-    # pak_data = [lakeno, strt, nlakeconn]
+    # pak_data = [ifno, strt, nlakeconn]
     initial_stage = 0.1
     pak_data = [(0, initial_stage, nlakeconn)]
 

diff --git a/autotest/test_gwf_auxvars.py b/autotest/test_gwf_auxvars.py
@@ -176,12 +176,12 @@ def build_model(idx, dir):
     )
     # sfr.remove()
 
-    # <lakeno> <strt> <nlakeconn> [<aux(naux)>] [<boundname>]
+    # <ifno> <strt> <nlakeconn> [<aux(naux)>] [<boundname>]
     packagedata = [
         [0, 100.0, 1, auxvar1, auxvar2, "lake1"],
         [1, 100.0, 1, auxvar1, auxvar2, "lake2"],
     ]
-    # <lakeno> <iconn> <cellid(ncelldim)> <claktype> <bedleak> <belev> <telev> <connlen> <connwidth>
+    # <ifno> <iconn> <cellid(ncelldim)> <claktype> <bedleak> <belev> <telev> <connlen> <connwidth>
     connectiondata = [
         [0, 0, (0, 1, 1), "vertical", DNODATA, 0.0, 0.0, 0.0, 0.0],
         [1, 0, (0, 2, 2), "vertical", DNODATA, 0.0, 0.0, 0.0, 0.0],

diff --git a/autotest/test_gwf_buy_lak01.py b/autotest/test_gwf_buy_lak01.py
@@ -130,14 +130,14 @@ def build_model(idx, dir):
         )
 
     nlakeconn = 11  # note: number of connections for this lake
-    # pak_data = [lakeno, strt, nlakeconn, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, dense, boundname]
     pak_data = [(0, 2.25, nlakeconn, lake_dense)]
 
     connlen = delr / 2.0
     connwidth = delc
     bedleak = "None"
     con_data = [
-        # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+        # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
         (0, 0, (0, 0, 0), "HORIZONTAL", bedleak, 10, 10, connlen, connwidth),
         (0, 1, (1, 0, 1), "VERTICAL", bedleak, 10, 10, connlen, connwidth),
         (0, 2, (1, 0, 1), "HORIZONTAL", bedleak, 10, 10, connlen, connwidth),

diff --git a/autotest/test_gwf_buy_lak02.py b/autotest/test_gwf_buy_lak02.py
@@ -144,14 +144,14 @@ def case_generator(self, data, function_tmpdir):
             buy = flopy.mf6.ModflowGwfbuy(gwf, denseref=1000.0, packagedata=pd)
 
         nlakeconn = 11  # note: number of connections for this lake
-        # pak_data = [lakeno, strt, nlakeconn, testauxvar, concentration, boundname]
+        # pak_data = [ifno, strt, nlakeconn, testauxvar, concentration, boundname]
         pak_data = [(0, 2.25, nlakeconn, 0.0, 0.0)]
 
         connlen = delr / 2.0
         connwidth = delc
         bedleak = "None"
         con_data = [
-            # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+            # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
             (
                 0,
                 0,

diff --git a/autotest/test_gwf_lak_bedleak.py b/autotest/test_gwf_lak_bedleak.py
@@ -116,12 +116,12 @@ def build_model(idx, dir):
     else:
         bedleak = DNODATA
 
-    # <lakeno> <strt> <nlakeconn> [<aux(naux)>] [<boundname>]
+    # <ifno> <strt> <nlakeconn> [<aux(naux)>] [<boundname>]
     packagedata = [
         [0, 100.0, 1, "lake1"],
         [1, 100.0, 1, "lake2"],
     ]
-    # <lakeno> <iconn> <cellid(ncelldim)> <claktype> <bedleak> <belev> <telev> <connlen> <connwidth>
+    # <ifno> <iconn> <cellid(ncelldim)> <claktype> <bedleak> <belev> <telev> <connlen> <connwidth>
     connectiondata = [
         [0, 0, (0, 1, 1), "vertical", bedleak, 0.0, 0.0, 0.0, 0.0],
         [1, 0, (0, 2, 2), "vertical", bedleak, 0.0, 0.0, 0.0, 0.0],

diff --git a/autotest/test_gwf_laket.py b/autotest/test_gwf_laket.py
@@ -112,7 +112,7 @@ def get_model(idx, ws):
     ]
     nlakeconn = 1
 
-    # pak_data = [lakeno, strt, nlakeconn]
+    # pak_data = [ifno, strt, nlakeconn]
     pak_data = [(0, lakestage[idx], nlakeconn)]
 
     belev = top

diff --git a/autotest/test_gwf_lakobs01.py b/autotest/test_gwf_lakobs01.py
@@ -138,7 +138,7 @@ def build_model(dir, exe):
             irch[i, j] = k + 1
     nlakeconn = len(lake_vconnect)
 
-    # pak_data = [lakeno, strt, nlakeconn]
+    # pak_data = [ifno, strt, nlakeconn]
     initial_stage = 0.1
     pak_data = [(0, initial_stage, nlakeconn)]
 

diff --git a/autotest/test_gwf_vsc04_lak.py b/autotest/test_gwf_vsc04_lak.py
@@ -331,7 +331,7 @@ def build_model(idx, ws):
                             # by setting belev==telev, MF6 will automatically
                             # re-assign elevations based on cell dimensions
                             h = [
-                                ilak,  # <lakeno>
+                                ilak,  # <ifno>
                                 ilakconn,  # <iconn>
                                 (k, i - 1, j),  # <cellid(ncelldim)>
                                 "horizontal",  # <claktype>

diff --git a/autotest/test_gwt_lkt01.py b/autotest/test_gwt_lkt01.py
@@ -127,12 +127,12 @@ def build_model(idx, dir):
     )
 
     nlakeconn = 3  # note: this is the number of connectiosn for a lake, not total number of connections
-    # pak_data = [lakeno, strt, nlakeconn, CONC, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, CONC, dense, boundname]
     pak_data = [(0, -0.4, nlakeconn, 0.0, 1025.0)]
 
     connlen = connwidth = delr / 2.0
     con_data = []
-    # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+    # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
     con_data.append(
         (0, 0, (0, 0, 1), "HORIZONTAL", DNODATA, 10, 10, connlen, connwidth)
     )

diff --git a/autotest/test_gwt_lkt02.py b/autotest/test_gwt_lkt02.py
@@ -124,7 +124,7 @@ def build_model(idx, dir):
         filename=f"{gwfname}.chd",
     )
 
-    # pak_data = [lakeno, strt, nlakeconn, CONC, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, CONC, dense, boundname]
     pak_data = [
         (0, -0.4, 2, 0.0, 1025.0),
         (1, -0.4, 1, 0.0, 1025.0),
@@ -133,7 +133,7 @@ def build_model(idx, dir):
 
     connlen = connwidth = delr / 2.0
     con_data = []
-    # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+    # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
     # lake 1
     con_data.append(
         (0, 0, (0, 0, 1), "HORIZONTAL", DNODATA, 10, 10, connlen, connwidth)

diff --git a/autotest/test_gwt_lkt03.py b/autotest/test_gwt_lkt03.py
@@ -122,7 +122,7 @@ def build_model(idx, dir):
         filename=f"{gwfname}.chd",
     )
 
-    # pak_data = [lakeno, strt, nlakeconn, CONC, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, CONC, dense, boundname]
     pak_data = [
         (0, 0.0, 1, 0.0, 1025.0),
         (1, 0.0, 1, 0.0, 1025.0),
@@ -131,7 +131,7 @@ def build_model(idx, dir):
 
     connlen = connwidth = delr / 2.0
     con_data = []
-    # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+    # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
     # lake 1
     con_data.append(
         (0, 0, (0, 0, 2), "VERTICAL", DNODATA, 10, 10, connlen, connwidth)

diff --git a/autotest/test_gwt_lkt04.py b/autotest/test_gwt_lkt04.py
@@ -127,12 +127,12 @@ def build_model(idx, dir, exe):
     )
 
     nlakeconn = 3  # note: this is the number of connectiosn for a lake, not total number of connections
-    # pak_data = [lakeno, strt, nlakeconn, CONC, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, CONC, dense, boundname]
     pak_data = [(0, -0.4, nlakeconn, 0.0, 1025.0)]
 
     connlen = connwidth = delr / 2.0
     con_data = []
-    # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+    # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
     con_data.append(
         (0, 0, (0, 0, 1), "HORIZONTAL", DNODATA, 10, 10, connlen, connwidth)
     )

diff --git a/autotest/test_gwt_mvt01.py b/autotest/test_gwt_mvt01.py
@@ -142,15 +142,15 @@ def build_model(idx, dir):
     )
 
     nlakeconn = 1  # note: this is the number of connectiosn for a lake, not total number of connections
-    # pak_data = [lakeno, strt, nlakeconn, CONC, dense, boundname]
+    # pak_data = [ifno, strt, nlakeconn, CONC, dense, boundname]
     pak_data = [
         (0, 1.0, nlakeconn, 0.0, 1025.0),
         (1, 1.0, nlakeconn, 0.0, 1025.0),
     ]
 
     connlen = connwidth = delr / 2.0
     con_data = []
-    # con_data=(lakeno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
+    # con_data=(ifno,iconn,(cellid),claktype,bedleak,belev,telev,connlen,connwidth )
     con_data.append(
         (0, 0, (0, 0, 0), "VERTICAL", 0.0, 0, 0, connlen, connwidth)
     )

diff --git a/doc/Common/gwf-lakobs.tex b/doc/Common/gwf-lakobs.tex
@@ -1,19 +1,19 @@
-LAK & stage & lakeno or boundname & -- & Surface-water stage in a lake. If boundname is specified, boundname must be unique for each lake. \\
-LAK & ext-inflow & lakeno or boundname & -- & Specified inflow into a lake or group of lakes. \\
-LAK & outlet-inflow & lakeno or boundname & -- & Simulated inflow from upstream lake outlets into a lake or group of lakes. \\
-LAK & inflow & lakeno or boundname & -- & Sum of specified inflow and simulated inflow from upstream lake outlets into a lake or group of lakes. \\
-LAK & from-mvr & lakeno or boundname & -- & Inflow into a lake or group of lakes from the MVR package. \\
-LAK & rainfall & lakeno or boundname & -- & Rainfall rate applied to a lake or group of lakes. \\
-LAK & runoff & lakeno or boundname & -- & Runoff rate applied to a lake or group of lakes. \\
-LAK & lak & lakeno or boundname & \texttt{iconn} or -- & Simulated flow rate for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the simulated lake-aquifer flow rate at a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}. \\
-LAK & withdrawal & lakeno or boundname & -- & Specified withdrawal rate from a lake or group of lakes. \\
-LAK & evaporation & lakeno or boundname & -- & Simulated evaporation rate from a lake or group of lakes. \\
+LAK & stage & ifno or boundname & -- & Surface-water stage in a lake. If boundname is specified, boundname must be unique for each lake. \\
+LAK & ext-inflow & ifno or boundname & -- & Specified inflow into a lake or group of lakes. \\
+LAK & outlet-inflow & ifno or boundname & -- & Simulated inflow from upstream lake outlets into a lake or group of lakes. \\
+LAK & inflow & ifno or boundname & -- & Sum of specified inflow and simulated inflow from upstream lake outlets into a lake or group of lakes. \\
+LAK & from-mvr & ifno or boundname & -- & Inflow into a lake or group of lakes from the MVR package. \\
+LAK & rainfall & ifno or boundname & -- & Rainfall rate applied to a lake or group of lakes. \\
+LAK & runoff & ifno or boundname & -- & Runoff rate applied to a lake or group of lakes. \\
+LAK & lak & ifno or boundname & \texttt{iconn} or -- & Simulated flow rate for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the simulated lake-aquifer flow rate at a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}. \\
+LAK & withdrawal & ifno or boundname & -- & Specified withdrawal rate from a lake or group of lakes. \\
+LAK & evaporation & ifno or boundname & -- & Simulated evaporation rate from a lake or group of lakes. \\
 LAK & ext-outflow & outletno or boundname & -- & External outflow from a lake outlet, a lake, or a group of lakes to an external boundary. If boundname is not specified for ID, then the external outflow from a specific lake outlet is observed. In this case, ID is the outlet number outletno. \\
 LAK & to-mvr & outletno or boundname & -- & Outflow from a lake outlet, a lake, or a group of lakes that is available for the MVR package. If boundname is not specified for ID, then the outflow available for the MVR package from a specific lake outlet is observed. In this case, ID is the outlet number outletno. \\
-LAK & storage & lakeno or boundname & -- & Simulated storage flow rate for a lake or group of lakes. \\
-LAK & constant & lakeno or boundname & -- & Simulated constant-flow rate for a lake or group of lakes. \\
+LAK & storage & ifno or boundname & -- & Simulated storage flow rate for a lake or group of lakes. \\
+LAK & constant & ifno or boundname & -- & Simulated constant-flow rate for a lake or group of lakes. \\
 LAK & outlet & outletno or boundname & -- & Simulated outlet flow rate from a lake outlet, a lake, or a group of lakes. If boundname is not specified for ID, then the flow from a specific lake outlet is observed. In this case, ID is the outlet number outletno. \\
-LAK & volume & lakeno or boundname & -- & Simulated lake volume or group of lakes. \\
-LAK & surface-area & lakeno or boundname & -- & Simulated surface area for a lake or group of lakes. \\
-LAK & wetted-area & lakeno or boundname & \texttt{iconn} or -- & Simulated wetted-area for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the wetted area of a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}. \\
-LAK & conductance & lakeno or boundname & \texttt{iconn} or -- & Calculated conductance for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the calculated conductance of a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}.
+LAK & volume & ifno or boundname & -- & Simulated lake volume or group of lakes. \\
+LAK & surface-area & ifno or boundname & -- & Simulated surface area for a lake or group of lakes. \\
+LAK & wetted-area & ifno or boundname & \texttt{iconn} or -- & Simulated wetted-area for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the wetted area of a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}. \\
+LAK & conductance & ifno or boundname & \texttt{iconn} or -- & Calculated conductance for a lake or group of lakes and its aquifer connection(s). If boundname is not specified for ID, then the calculated conductance of a specific lake connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn}.