completes the standardization of the advanced package feature number …

…naming
modflowpy · Sep 21, 2023 · 1834dee · 1834dee
1 parent 769a25e
commit 1834dee
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 49 deletions.
diff --git a/flopy/mf6/data/dfn/gwf-lak.dfn b/flopy/mf6/data/dfn/gwf-lak.dfn
@@ -349,21 +349,21 @@ description value specifying the number of lakes tables that will be used to def
 
 block packagedata
 name packagedata
-type recarray lakeno strt nlakeconn aux boundname
+type recarray ifno strt nlakeconn aux boundname
 shape (maxbound)
 reader urword
 longname
 description
 
 block packagedata
-name lakeno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname lake number for this entry
-description integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error.  The program will also terminate with an error if information for a lake is specified more than once.
+description integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error.  The program will also terminate with an error if information for a lake is specified more than once.
 numeric_index true
 
 block packagedata
@@ -384,7 +384,7 @@ tagged false
 in_record true
 reader urword
 longname number of lake connections
-description integer value that defines the number of GWF cells connected to this (LAKENO) lake. There can only be one vertical lake connection to each GWF cell. NLAKECONN must be greater than zero.
+description integer value that defines the number of GWF cells connected to this (IFNO) lake. There can only be one vertical lake connection to each GWF cell. NLAKECONN must be greater than zero.
 
 block packagedata
 name aux
@@ -414,21 +414,21 @@ description REPLACE boundname {'{#1}': 'lake'}
 
 block connectiondata
 name connectiondata
-type recarray lakeno iconn cellid claktype bedleak belev telev connlen connwidth
+type recarray ifno iconn cellid claktype bedleak belev telev connlen connwidth
 shape (sum(nlakeconn))
 reader urword
 longname
 description
 
 block connectiondata
-name lakeno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname lake number for this entry
-description integer value that defines the lake number associated with the specified CONNECTIONDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake connection information must be specified for every lake connection to the GWF model (NLAKECONN) or the program will terminate with an error.  The program will also terminate with an error if connection information for a lake connection to the GWF model is specified more than once.
+description integer value that defines the feature (lake) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake connection information must be specified for every lake connection to the GWF model (NLAKECONN) or the program will terminate with an error.  The program will also terminate with an error if connection information for a lake connection to the GWF model is specified more than once.
 numeric_index true
 
 block connectiondata
@@ -439,7 +439,7 @@ tagged false
 in_record true
 reader urword
 longname connection number for this entry
-description integer value that defines the GWF connection number for this lake connection entry. ICONN must be greater than zero and less than or equal to NLAKECONN for lake LAKENO.
+description integer value that defines the GWF connection number for this lake connection entry. ICONN must be greater than zero and less than or equal to NLAKECONN for lake IFNO.
 numeric_index true
 
 block connectiondata
@@ -470,7 +470,7 @@ tagged false
 in_record true
 reader urword
 longname bed leakance
-description character string or real value that defines the bed leakance for the lake-GWF connection. BEDLEAK must be greater than or equal to zero or specified to be NONE. If BEDLEAK is specified to be NONE, the lake-GWF connection conductance is solely a function of aquifer properties in the connected GWF cell and lakebed sediments are assumed to be absent.
+description real value or character string that defines the bed leakance for the lake-GWF connection. BEDLEAK must be greater than or equal to zero, equal to the DNODATA value (3.0E+30), or specified to be NONE. If DNODATA or NONE is specified for BEDLEAK, the lake-GWF connection conductance is solely a function of aquifer properties in the connected GWF cell and lakebed sediments are assumed to be absent. Warning messages will be issued if NONE is specified. Eventually the ability to specify NONE will be deprecated and cause MODFLOW 6 to terminate with an error.
 
 block connectiondata
 name belev
@@ -517,21 +517,21 @@ description real value that defines the connection face width for a HORIZONTAL l
 
 block tables
 name tables
-type recarray lakeno tab6 filein tab6_filename
+type recarray ifno tab6 filein tab6_filename
 shape (ntables)
 reader urword
 longname
 description
 
 block tables
-name lakeno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname lake number for this entry
-description integer value that defines the lake number associated with the specified TABLES data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. The program will terminate with an error if table information for a lake is specified more than once or the number of specified tables is less than NTABLES.
+description integer value that defines the feature (lake) number associated with the specified TABLES data on the line. IFNO must be greater than zero and less than or equal to NLAKES. The program will terminate with an error if table information for a lake is specified more than once or the number of specified tables is less than NTABLES.
 numeric_index true
 
 block tables
@@ -796,7 +796,7 @@ in_record true
 reader urword
 time_series true
 longname extraction rate
-description real or character value that defines the extraction rate for the lake outflow. A positive value indicates inflow and a negative value indicates outflow from the lake. RATE only applies to active (IBOUND $>$ 0) lakes. A specified RATE is only applied if COUTTYPE for the OUTLETNO is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each SPECIFIED lake outlet is zero.
+description real or character value that defines the extraction rate for the lake outflow. A positive value indicates inflow and a negative value indicates outflow from the lake. RATE only applies to outlets associated with active lakes (STATUS is ACTIVE). A specified RATE is only applied if COUTTYPE for the OUTLETNO is SPECIFIED. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each SPECIFIED lake outlet is zero.
 
 block period
 name invert

diff --git a/flopy/mf6/data/dfn/gwf-maw.dfn b/flopy/mf6/data/dfn/gwf-maw.dfn
@@ -334,21 +334,21 @@ description integer value specifying the number of multi-aquifer wells that will
 
 block packagedata
 name packagedata
-type recarray wellno radius bottom strt condeqn ngwfnodes aux boundname
+type recarray ifno radius bottom strt condeqn ngwfnodes aux boundname
 shape (nmawwells)
 reader urword
 longname
 description
 
 block packagedata
-name wellno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname well number for this entry
-description integer value that defines the well number associated with the specified PACKAGEDATA data on the line. WELLNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error.  The program will also terminate with an error if information for a multi-aquifer well is specified more than once.
+description integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error.  The program will also terminate with an error if information for a multi-aquifer well is specified more than once.
 numeric_index true
 
 block packagedata
@@ -399,7 +399,7 @@ tagged false
 in_record true
 reader urword
 longname number of connected GWF cells
-description integer value that defines the number of GWF nodes connected to this (WELLNO) multi-aquifer well. NGWFNODES must be greater than zero.
+description integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be greater than zero.
 
 block packagedata
 name aux
@@ -429,20 +429,20 @@ description REPLACE boundname {'{#1}': 'multi-aquifer well'}
 
 block connectiondata
 name connectiondata
-type recarray wellno icon cellid scrn_top scrn_bot hk_skin radius_skin
+type recarray ifno icon cellid scrn_top scrn_bot hk_skin radius_skin
 reader urword
 longname
 description
 
 block connectiondata
-name wellno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname well number for this entry
-description integer value that defines the well number associated with the specified CONNECTIONDATA data on the line. WELLNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error.  The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once.
+description integer value that defines the feature (well) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error.  The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once.
 numeric_index true
 
 block connectiondata
@@ -453,7 +453,7 @@ tagged false
 in_record true
 reader urword
 longname connection number
-description integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well WELLNO.
+description integer value that defines the GWF connection number for this multi-aquifer well connection entry. ICONN must be greater than zero and less than or equal to NGWFNODES for multi-aquifer well IFNO.
 numeric_index true
 
 block connectiondata
@@ -524,21 +524,21 @@ description REPLACE iper {}
 
 block period
 name perioddata
-type recarray wellno mawsetting
+type recarray ifno mawsetting
 shape
 reader urword
 longname
 description
 
 block period
-name wellno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname well number for this entry
-description integer value that defines the well number associated with the specified PERIOD data on the line. WELLNO must be greater than zero and less than or equal to NMAWWELLS.
+description integer value that defines the well number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS.
 numeric_index true
 
 block period
@@ -619,7 +619,7 @@ in_record true
 reader urword
 time_series true
 longname well pumping rate
-description is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (IBOUND $>$ 0) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each multi-aquifer well is zero.
+description is the volumetric pumping rate for the multi-aquifer well. A positive value indicates recharge and a negative value indicates discharge (pumping). RATE only applies to active (STATUS is ACTIVE) multi-aquifer wells. If the Options block includes a TIMESERIESFILE entry (see the ``Time-Variable Input'' section), values can be obtained from a time series by entering the time-series name in place of a numeric value. By default, the RATE for each multi-aquifer well is zero.
 
 block period
 name well_head

diff --git a/flopy/mf6/data/dfn/gwf-uzf.dfn b/flopy/mf6/data/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/flopy/mf6/data/dfn/gwt-lkt.dfn b/flopy/mf6/data/dfn/gwt-lkt.dfn
@@ -259,21 +259,21 @@ description REPLACE obs6_filename {'{#1}': 'LKT'}
 
 block packagedata
 name packagedata
-type recarray lakeno strt aux boundname
+type recarray ifno strt aux boundname
 shape (maxbound)
 reader urword
 longname
 description
 
 block packagedata
-name lakeno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname lake number for this entry
-description integer value that defines the lake number associated with the specified PACKAGEDATA data on the line. LAKENO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error.  The program will also terminate with an error if information for a lake is specified more than once.
+description integer value that defines the feature (lake) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NLAKES. Lake information must be specified for every lake or the program will terminate with an error.  The program will also terminate with an error if information for a lake is specified more than once.
 numeric_index true
 
 block packagedata
@@ -327,21 +327,21 @@ description REPLACE iper {}
 
 block period
 name lakeperioddata
-type recarray lakeno laksetting
+type recarray ifno laksetting
 shape
 reader urword
 longname
 description
 
 block period
-name lakeno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname lake number for this entry
-description integer value that defines the lake number associated with the specified PERIOD data on the line. LAKENO must be greater than zero and less than or equal to NLAKES.
+description integer value that defines the feature (lake) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NLAKES.
 numeric_index true
 
 block period

diff --git a/flopy/mf6/data/dfn/gwt-mwt.dfn b/flopy/mf6/data/dfn/gwt-mwt.dfn
@@ -259,21 +259,21 @@ description REPLACE obs6_filename {'{#1}': 'MWT'}
 
 block packagedata
 name packagedata
-type recarray mawno strt aux boundname
+type recarray ifno strt aux boundname
 shape (maxbound)
 reader urword
 longname
 description
 
 block packagedata
-name mawno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname well number for this entry
-description integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error.  The program will also terminate with an error if information for a well is specified more than once.
+description integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error.  The program will also terminate with an error if information for a well is specified more than once.
 numeric_index true
 
 block packagedata
@@ -327,21 +327,21 @@ description REPLACE iper {}
 
 block period
 name mwtperioddata
-type recarray mawno mwtsetting
+type recarray ifno mwtsetting
 shape
 reader urword
 longname
 description
 
 block period
-name mawno
+name ifno
 type integer
 shape
 tagged false
 in_record true
 reader urword
 longname well number for this entry
-description integer value that defines the well number associated with the specified PERIOD data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS.
+description integer value that defines the feature (well) number associated with the specified PERIOD data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS.
 numeric_index true
 
 block period