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

… UZT dfn files (#1361)
MODFLOW-USGS · Sep 26, 2023 · 0cf3d1f · 0cf3d1f
1 parent df05f9e
commit 0cf3d1f
Show file tree

Hide file tree

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

diff --git a/autotest/test_gwf_auxvars.py b/autotest/test_gwf_auxvars.py
@@ -202,14 +202,14 @@ def build_model(idx, dir):
     )
     # lak.remove()
 
-    # <iuzno> <cellid(ncelldim)> <landflag> <ivertcon> <surfdep> <vks> <thtr> <thts> <thti> <eps> [<boundname>]
+    # <ifno> <cellid(ncelldim)> <landflag> <ivertcon> <surfdep> <vks> <thtr> <thts> <thti> <eps> [<boundname>]
     packagedata = [
         [0, (0, nrow - 1, 5), 1, -1, 0.1, 0.01, 0.01, 0.1, 0.01, 3.5, "uz1"],
         [1, (0, nrow - 1, 6), 1, -1, 0.1, 0.01, 0.01, 0.1, 0.01, 3.5, "uz1"],
         [2, (0, nrow - 1, 7), 1, -1, 0.1, 0.01, 0.01, 0.1, 0.01, 3.5, "uz1"],
         [3, (0, nrow - 1, 8), 1, -1, 0.1, 0.01, 0.01, 0.1, 0.01, 3.5, "uz1"],
     ]
-    # <iuzno> <finf> <pet> <extdp> <extwc> <ha> <hroot> <rootact> [<aux(naux)>]
+    # <ifno> <finf> <pet> <extdp> <extwc> <ha> <hroot> <rootact> [<aux(naux)>]
     perioddata = []
     for p in packagedata:
         perioddata.append(

diff --git a/autotest/test_gwf_uzf_gwet.py b/autotest/test_gwf_uzf_gwet.py
@@ -97,7 +97,7 @@ def build_model(idx, dir):
     )
 
     # transient uzf info
-    # iuzno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
+    # ifno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
     uzf_pkdat = [
         [0, (0, 0, 1), 1, 8, 1, 1, 0.05, 0.35, 0.05, 4, "uzf01"],
         [1, (0, 0, 2), 1, 9, 1, 1, 0.05, 0.35, 0.05, 4, "uzf02"],

diff --git a/autotest/test_gwf_uzf_surfdep.py b/autotest/test_gwf_uzf_surfdep.py
@@ -98,7 +98,7 @@ def build_model(dir, exe):
     )
 
     # transient uzf info
-    # iuzno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
+    # ifno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
     uzf_pkdat = [
         [0, (0, 0, 1), 1, 8, 6, 1, 0.05, 0.35, 0.05, 4, "uzf01"],
         [1, (0, 0, 2), 1, 9, 6, 1, 0.05, 0.35, 0.05, 4, "uzf02"],

diff --git a/autotest/test_gwf_uzf_wc_output.py b/autotest/test_gwf_uzf_wc_output.py
@@ -49,7 +49,7 @@
     3: [[(2, 0, 0), ghbelv2, ghbcond], [(2, 0, ncol - 1), ghbelv2, ghbcond]],
 }
 
-# iuzno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
+# ifno  cellid landflg ivertcn surfdp vks thtr thts thti eps [bndnm]
 surfdep1 = 1.0
 surfdep2 = 0.001
 vks = 0.5

diff --git a/doc/Common/gwf-uzfobs.tex b/doc/Common/gwf-uzfobs.tex
@@ -1,12 +1,12 @@
-UZF & uzf-gwrch & iuzno or boundname & -- & Simulated recharge to the aquifer calculated by the UZF package for a UZF cell or a group of UZF cells.\\
-UZF & uzf-gwd & iuzno or boundname & -- & Simulated groundwater discharge to the land surface calculated by the UZF package for a UZF cell or a group of UZF cells. \\
-UZF & uzf-gwd-to-mvr & iuzno or boundname & -- & Simulated groundwater discharge to the land surface calculated by the UZF package that is available to the MVR package for a UZF cell or a group of UZF cells. \\
-UZF & uzf-gwet & iuzno or boundname & -- & Simulated groundwater evapotranspiration calculated by the UZF package for a UZF cell or a group of UZF cells.\\
-UZF & infiltration & iuzno or boundname & -- & Specified infiltration rate applied to a UZF package for a UZF cell or a group of UZF cells with landflag values not equal to zero.\\
-UZF & from-mvr & iuzno or boundname & -- & Inflow into a UZF cell from the MVR package for a UZF cell or a group of UZF cells. \\
-UZF & rej-inf & iuzno or boundname & -- & Simulated rejected infiltration calculated by the UZF package for a UZF cell or a group of UZF cells. \\
-UZF & rej-inf-to-mvr & iuzno or boundname & -- & Simulated rejected infiltration calculated by the UZF package that is available to the MVR package for a UZF cell or a group of UZF cells. \\
-UZF & uzet & iuzno or boundname & -- & Simulated unsaturated evapotranspiration calculated by the UZF package for a UZF cell or a group of UZF cells.\\
-UZF & storage & iuzno or boundname & -- & Simulated storage flow rate for a UZF package cell or a group of UZF cells. \\
-UZF & net-infiltration & iuzno or boundname & -- & Simulated net infiltration rate for a UZF package cell or a group of UZF cells. \\
-UZF & water-content & iuzno or boundname & depth & Unsaturated-zone water content at a user-specified depth (ID2) relative to the top of GWF cellid for a UZF cell. The user-specified depth must be greater than or equal to zero and less than the thickness of GWF cellid (TOP - BOT). If boundname is specified, boundname must be unique for each UZF cell.
+UZF & uzf-gwrch & ifno or boundname & -- & Simulated recharge to the aquifer calculated by the UZF package for a UZF cell or a group of UZF cells.\\
+UZF & uzf-gwd & ifno or boundname & -- & Simulated groundwater discharge to the land surface calculated by the UZF package for a UZF cell or a group of UZF cells. \\
+UZF & uzf-gwd-to-mvr & ifno or boundname & -- & Simulated groundwater discharge to the land surface calculated by the UZF package that is available to the MVR package for a UZF cell or a group of UZF cells. \\
+UZF & uzf-gwet & ifno or boundname & -- & Simulated groundwater evapotranspiration calculated by the UZF package for a UZF cell or a group of UZF cells.\\
+UZF & infiltration & ifno or boundname & -- & Specified infiltration rate applied to a UZF package for a UZF cell or a group of UZF cells with landflag values not equal to zero.\\
+UZF & from-mvr & ifno or boundname & -- & Inflow into a UZF cell from the MVR package for a UZF cell or a group of UZF cells. \\
+UZF & rej-inf & ifno or boundname & -- & Simulated rejected infiltration calculated by the UZF package for a UZF cell or a group of UZF cells. \\
+UZF & rej-inf-to-mvr & ifno or boundname & -- & Simulated rejected infiltration calculated by the UZF package that is available to the MVR package for a UZF cell or a group of UZF cells. \\
+UZF & uzet & ifno or boundname & -- & Simulated unsaturated evapotranspiration calculated by the UZF package for a UZF cell or a group of UZF cells.\\
+UZF & storage & ifno or boundname & -- & Simulated storage flow rate for a UZF package cell or a group of UZF cells. \\
+UZF & net-infiltration & ifno or boundname & -- & Simulated net infiltration rate for a UZF package cell or a group of UZF cells. \\
+UZF & water-content & ifno or boundname & depth & Unsaturated-zone water content at a user-specified depth (ID2) relative to the top of GWF cellid for a UZF cell. The user-specified depth must be greater than or equal to zero and less than the thickness of GWF cellid (TOP - BOT). If boundname is specified, boundname must be unique for each UZF cell.
diff --git a/doc/Common/gwt-uztobs.tex b/doc/Common/gwt-uztobs.tex
@@ -1,14 +1,14 @@
 % general APT observations
-UZT & concentration & uztno or boundname & -- & uzt cell concentration. If boundname is specified, boundname must be unique for each uzt cell. \\
-UZT & flow-ja-face & uztno or boundname & uztno or -- & Mass flow between two uzt cells.  If a boundname is specified for ID1, then the result is the total mass flow for all uzt cells. If a boundname is specified for ID1 then ID2 is not used.\\
-UZT & storage & uztno or boundname & -- & Simulated mass storage flow rate for a uzt cell or group of uzt cells. \\
-UZT & constant & uztno or boundname & -- & Simulated mass constant-flow rate for a uzt cell or a group of uzt cells. \\
-UZT & from-mvr & uztno or boundname & -- & Simulated mass inflow into a uzt cell or group of uzt cells from the MVT package. Mass inflow is calculated as the product of provider concentration and the mover flow rate. \\
-UZT & uzt & uztno or boundname & -- & Mass flow rate for a uzt cell or group of uzt cells and its aquifer connection(s). \\
+UZT & concentration & ifno or boundname & -- & uzt cell concentration. If boundname is specified, boundname must be unique for each uzt cell. \\
+UZT & flow-ja-face & ifno or boundname & ifno or -- & Mass flow between two uzt cells.  If a boundname is specified for ID1, then the result is the total mass flow for all uzt cells. If a boundname is specified for ID1 then ID2 is not used.\\
+UZT & storage & ifno or boundname & -- & Simulated mass storage flow rate for a uzt cell or group of uzt cells. \\
+UZT & constant & ifno or boundname & -- & Simulated mass constant-flow rate for a uzt cell or a group of uzt cells. \\
+UZT & from-mvr & ifno or boundname & -- & Simulated mass inflow into a uzt cell or group of uzt cells from the MVT package. Mass inflow is calculated as the product of provider concentration and the mover flow rate. \\
+UZT & uzt & ifno or boundname & -- & Mass flow rate for a uzt cell or group of uzt cells and its aquifer connection(s). \\
 
 %observations specific to the uzt package
 % infiltration rej-inf uzet rej-inf-to-mvr
-UZT & infiltration & uztno or boundname & -- & Infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration. \\
-UZT & rej-inf & uztno or boundname & -- & Rejected infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration. \\
-UZT & uzet & uztno or boundname & -- & Unsaturated zone evapotranspiration rate applied to a uzt cell or group of uzt cells multiplied by the uzt cell concentration. \\
-UZT & rej-inf-to-mvr & uztno or boundname & -- & Rejected infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration that is sent to the mover package. \\
+UZT & infiltration & ifno or boundname & -- & Infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration. \\
+UZT & rej-inf & ifno or boundname & -- & Rejected infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration. \\
+UZT & uzet & ifno or boundname & -- & Unsaturated zone evapotranspiration rate applied to a uzt cell or group of uzt cells multiplied by the uzt cell concentration. \\
+UZT & rej-inf-to-mvr & ifno or boundname & -- & Rejected infiltration rate applied to a uzt cell or group of uzt cells multiplied by the infiltration concentration that is sent to the mover package. \\
diff --git a/doc/mf6io/mf6ivar/dfn/gwf-uzf.dfn b/doc/mf6io/mf6ivar/dfn/gwf-uzf.dfn
@@ -365,21 +365,21 @@ default_value 40
 
 block packagedata
 name packagedata
-type recarray iuzno cellid landflag ivertcon surfdep vks thtr thts thti eps boundname
+type recarray ifno cellid landflag ivertcon surfdep vks thtr thts thti eps boundname
 shape (nuzfcells)
 reader urword
 longname
 description
 
 block packagedata
-name iuzno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname uzf id number for this entry
-description integer value that defines the UZF cell number associated with the specified PACKAGEDATA data on the line. IUZNO must be greater than zero and less than or equal to NUZFCELLS.  UZF information must be specified for every UZF cell or the program will terminate with an error.  The program will also terminate with an error if information for a UZF cell is specified more than once.
+description integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS.  UZF information must be specified for every UZF cell or the program will terminate with an error.  The program will also terminate with an error if information for a UZF cell is specified more than once.
 numeric_index true
 
 block packagedata
@@ -502,21 +502,21 @@ description REPLACE iper {}
 
 block period
 name perioddata
-type recarray iuzno finf pet extdp extwc ha hroot rootact aux
+type recarray ifno finf pet extdp extwc ha hroot rootact aux
 shape
 reader urword
 longname
 description
 
 block period
-name iuzno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname UZF id number
-description integer value that defines the UZF cell number associated with the specified PERIOD data on the line.
+description integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line.
 numeric_index true
 
 block period

diff --git a/doc/mf6io/mf6ivar/dfn/gwt-uzt.dfn b/doc/mf6io/mf6ivar/dfn/gwt-uzt.dfn
@@ -259,21 +259,21 @@ description REPLACE obs6_filename {'{#1}': 'UZT'}
 
 block packagedata
 name packagedata
-type recarray uzfno strt aux boundname
+type recarray ifno strt aux boundname
 shape (maxbound)
 reader urword
 longname
 description
 
 block packagedata
-name uzfno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname UZF cell number for this entry
-description integer value that defines the UZF cell number associated with the specified PACKAGEDATA data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error.  The program will also terminate with an error if information for a UZF cell is specified more than once.
+description integer value that defines the feature (UZF object) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS. Unsaturated zone flow information must be specified for every UZF cell or the program will terminate with an error.  The program will also terminate with an error if information for a UZF cell is specified more than once.
 numeric_index true
 
 block packagedata
@@ -327,21 +327,21 @@ description REPLACE iper {}
 
 block period
 name uztperioddata
-type recarray uzfno uztsetting
+type recarray ifno uztsetting
 shape
 reader urword
 longname
 description
 
 block period
-name uzfno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname unsaturated zone flow cell number for this entry
-description integer value that defines the UZF cell number associated with the specified PERIOD data on the line. UZFNO must be greater than zero and less than or equal to NUZFCELLS.
+description integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NUZFCELLS.
 numeric_index true
 
 block period

diff --git a/doc/mf6io/mf6ivar/examples/gwt-uzt-example-obs.dat b/doc/mf6io/mf6ivar/examples/gwt-uzt-example-obs.dat
@@ -4,9 +4,10 @@ BEGIN options
 END options
 
 BEGIN continuous  FILEOUT  gwt_02.uzt.obs.csv
-  mwt-1-conc  CONCENTRATION  1
-  mwt-1-stor  STORAGE  1
-  mwt-1-gwt1  UZT  1
-  mwt-1-gwt2  UZT  2
-  mwt-2-gwt1  UZT  3
+# obs_name      obs_type         ID
+  mwt-1-conc    CONCENTRATION     1
+  mwt-1-stor    STORAGE           1
+  mwt-1-gwt1    UZT               1
+  mwt-1-gwt2    UZT               2
+  mwt-2-gwt1    UZT               3
 END continuous
diff --git a/doc/mf6io/mf6ivar/examples/gwt-uzt-example.dat b/doc/mf6io/mf6ivar/examples/gwt-uzt-example.dat
@@ -11,10 +11,10 @@ BEGIN OPTIONS
 END OPTIONS
 
 BEGIN PACKAGEDATA
-# L             STRT             aux1             aux2    bname
-  1       0.00000000      99.00000000     999.00000000  MYUZFCELL1
-  2       0.00000000      99.00000000     999.00000000  MYUZFCELL2
-  3       0.00000000      99.00000000     999.00000000  MYUZFCELL3
+# ifno         STRT             aux1             aux2       bname
+     1   0.00000000      99.00000000     999.00000000  MYUZFCELL1
+     2   0.00000000      99.00000000     999.00000000  MYUZFCELL2
+     3   0.00000000      99.00000000     999.00000000  MYUZFCELL3
 END PACKAGEDATA
 
 BEGIN PERIOD  1