docs(uzf): clarified dfn descriptions for nuzfcells and ivertcon (#90)

closes #84
MODFLOW-USGS · Feb 13, 2019 · e42a6b8 · e42a6b8
1 parent bc013c5
commit e42a6b8
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 ## Automated Testing Status on Travis-CI
 
-### Version 6.0.3 develop &mdash; build 59
+### Version 6.0.3 develop &mdash; build 62
 [![Build Status](https://travis-ci.org/MODFLOW-USGS/modflow6.svg?branch=develop)](https://travis-ci.org/MODFLOW-USGS/modflow6)
 
 ## Introduction
@@ -31,7 +31,7 @@ MODFLOW 6 is the latest core version of MODFLOW. It synthesizes many of the capa
 
 #### ***Software/Code citation for MODFLOW 6:***
 
-[Langevin, C.D., Hughes, J.D., Banta, E.R., Provost, A.M., Niswonger, R.G., and Panday, Sorab, 2019, MODFLOW 6 Modular Hydrologic Model version 6.0.3 &mdash; develop: U.S. Geological Survey Software Release, 11 February 2019, https://doi.org/10.5066/F76Q1VQV](https://doi.org/10.5066/F76Q1VQV)
+[Langevin, C.D., Hughes, J.D., Banta, E.R., Provost, A.M., Niswonger, R.G., and Panday, Sorab, 2019, MODFLOW 6 Modular Hydrologic Model version 6.0.3 &mdash; develop: U.S. Geological Survey Software Release, 13 February 2019, https://doi.org/10.5066/F76Q1VQV](https://doi.org/10.5066/F76Q1VQV)
 
 ## Instructions for building definition files for new packages
 

diff --git a/code.json b/code.json
@@ -18,9 +18,9 @@
             "email": "langevin@usgs.gov"
         }, 
         "laborHours": -1, 
-        "version": "6.0.3.59", 
+        "version": "6.0.3.62", 
         "date": {
-            "metadataLastUpdated": "2019-02-11"
+            "metadataLastUpdated": "2019-02-13"
         }, 
         "organization": "U.S. Geological Survey", 
         "permissions": {

diff --git a/doc/mf6io/mf6ivar/dfn/gwf-uzf.dfn b/doc/mf6io/mf6ivar/dfn/gwf-uzf.dfn
@@ -242,7 +242,7 @@ type integer
 reader urword
 optional false
 longname number of UZF cells
-description is the number of UZF cells.  More than 1 UZF cell can be assigned to a GWF cell; however, only 1 GWF cell can be assigned to a single UZF cell. If the MULTILAYER option is used then UZF cells can be assigned to GWF cells below (in deeper layers than) the upper most active GWF cells.
+description is the number of UZF cells.  More than one UZF cell can be assigned to a GWF cell; however, only one GWF cell can be assigned to a single UZF cell. If more than one UZF cell is assigned to a GWF cell, then an auxiliary variable should be used to reduce the surface area of the UZF cell with the AUXMULTNAME option.
 
 block dimensions
 name ntrailwaves
@@ -310,7 +310,7 @@ tagged false
 in_record true
 reader urword
 longname vertical connection flag
-description integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches water table before the cell bottom then water is added to GWF cell instead of flowing to underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell.
+description integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches the water table before the cell bottom, then water is added to the GWF cell instead of flowing to the underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell.
 numeric_index true
 
 block packagedata

diff --git a/doc/mf6io/mf6ivar/md/mf6ivar.md b/doc/mf6io/mf6ivar/md/mf6ivar.md
@@ -553,13 +553,13 @@
 | GWF | UZF | OPTIONS | SIMULATE_GWSEEP | KEYWORD | keyword specifying that groundwater discharge (GWSEEP) to land surface will be simulated. Groundwater discharge is nonzero when groundwater head is greater than land surface. |
 | GWF | UZF | OPTIONS | UNSAT_ETWC | KEYWORD | keyword specifying that ET in the unsaturated zone will be simulated as a function of the specified PET rate while the water content (THETA) is greater than the ET extinction water content (EXTWC). |
 | GWF | UZF | OPTIONS | UNSAT_ETAE | KEYWORD | keyword specifying that ET in the unsaturated zone will be simulated simulated using a capillary pressure based formulation. Capillary pressure is calculated using the Brooks-Corey retention function. |
-| GWF | UZF | DIMENSIONS | NUZFCELLS | INTEGER | is the number of UZF cells.  More than 1 UZF cell can be assigned to a GWF cell; however, only 1 GWF cell can be assigned to a single UZF cell. If the MULTILAYER option is used then UZF cells can be assigned to GWF cells below (in deeper layers than) the upper most active GWF cells. |
+| GWF | UZF | DIMENSIONS | NUZFCELLS | INTEGER | is the number of UZF cells.  More than one UZF cell can be assigned to a GWF cell; however, only one GWF cell can be assigned to a single UZF cell. If more than one UZF cell is assigned to a GWF cell, then an auxiliary variable should be used to reduce the surface area of the UZF cell with the AUXMULTNAME option. |
 | GWF | UZF | DIMENSIONS | NTRAILWAVES | INTEGER | is the number of trailing waves.  NTRAILWAVES has a default value of 7 and can be increased to lower mass balance error in the unsaturated zone. |
 | GWF | UZF | DIMENSIONS | NWAVESETS | INTEGER | is the number of UZF cells specified.  NWAVESETS has a default value of 40 and can be increased if more waves are required to resolve variations in water content within the unsaturated zone. |
 | GWF | UZF | PACKAGEDATA | IUZNO | INTEGER | 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. |
 | GWF | UZF | PACKAGEDATA | CELLID | INTEGER (NCELLDIM) | is the cell identifier, and depends on the type of grid that is used for the simulation.  For a structured grid that uses the DIS input file, CELLID is the layer, row, and column.   For a grid that uses the DISV input file, CELLID is the layer and CELL2D number.  If the model uses the unstructured discretization (DISU) input file, CELLID is the node number for the cell. |
 | GWF | UZF | PACKAGEDATA | LANDFLAG | INTEGER | integer value set to one for land surface cells indicating that boundary conditions can be applied and data can be specified in the PERIOD block. A value of 0 specifies a non-land surface cell. |
-| GWF | UZF | PACKAGEDATA | IVERTCON | INTEGER | integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches water table before the cell bottom then water is added to GWF cell instead of flowing to underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell. |
+| GWF | UZF | PACKAGEDATA | IVERTCON | INTEGER | integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches the water table before the cell bottom, then water is added to the GWF cell instead of flowing to the underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell. |
 | GWF | UZF | PACKAGEDATA | SURFDEP | DOUBLE PRECISION | is the surface depression depth of the UZF cell. |
 | GWF | UZF | PACKAGEDATA | VKS | DOUBLE PRECISION | is the vertical saturated hydraulic conductivity of the UZF cell. |
 | GWF | UZF | PACKAGEDATA | THTR | DOUBLE PRECISION | is the residual (irreducible) water content of the UZF cell. |

diff --git a/doc/mf6io/mf6ivar/tex/gwf-uzf-desc.tex b/doc/mf6io/mf6ivar/tex/gwf-uzf-desc.tex
@@ -49,7 +49,7 @@
 \item \textbf{Block: DIMENSIONS}
 
 \begin{description}
-\item \texttt{nuzfcells}---is the number of UZF cells.  More than 1 UZF cell can be assigned to a GWF cell; however, only 1 GWF cell can be assigned to a single UZF cell. If the MULTILAYER option is used then UZF cells can be assigned to GWF cells below (in deeper layers than) the upper most active GWF cells.
+\item \texttt{nuzfcells}---is the number of UZF cells.  More than one UZF cell can be assigned to a GWF cell; however, only one GWF cell can be assigned to a single UZF cell. If more than one UZF cell is assigned to a GWF cell, then an auxiliary variable should be used to reduce the surface area of the UZF cell with the AUXMULTNAME option.
 
 \item \texttt{ntrailwaves}---is the number of trailing waves.  NTRAILWAVES has a default value of 7 and can be increased to lower mass balance error in the unsaturated zone.
 
@@ -65,7 +65,7 @@
 
 \item \texttt{landflag}---integer value set to one for land surface cells indicating that boundary conditions can be applied and data can be specified in the PERIOD block. A value of 0 specifies a non-land surface cell.
 
-\item \texttt{ivertcon}---integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches water table before the cell bottom then water is added to GWF cell instead of flowing to underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell.
+\item \texttt{ivertcon}---integer value set to specify underlying UZF cell that receives water flowing to bottom of cell. If unsaturated zone flow reaches the water table before the cell bottom, then water is added to the GWF cell instead of flowing to the underlying UZF cell. A value of 0 indicates the UZF cell is not connected to an underlying UZF cell.
 
 \item \texttt{surfdep}---is the surface depression depth of the UZF cell.
 

diff --git a/doc/version.tex b/doc/version.tex
@@ -1,3 +1,3 @@
-\newcommand{\modflowversion}{mf6.0.3.59}
-\newcommand{\modflowdate}{February 11, 2019}
+\newcommand{\modflowversion}{mf6.0.3.62}
+\newcommand{\modflowdate}{February 13, 2019}
 \newcommand{\currentmodflowversion}{Version \modflowversion---\modflowdate}
diff --git a/src/Utilities/version.f90 b/src/Utilities/version.f90
@@ -3,7 +3,7 @@ module VersionModule
   public
   ! -- modflow 6 version
   integer(I4B), parameter :: IDEVELOPMODE = 1
-  character(len=40), parameter :: VERSION = '6.0.3.59 02/11/2019'
+  character(len=40), parameter :: VERSION = '6.0.3.62 02/13/2019'
   character(len=10), parameter :: MFVNAM = ' 6'
   character(len=*), parameter  :: MFTITLE =                                     &
     'U.S. GEOLOGICAL SURVEY MODULAR HYDROLOGIC MODEL'

diff --git a/version.txt b/version.txt
@@ -1,12 +1,12 @@
 # MODFLOW 6 version file automatically created using...pre-commit.py
-# created on...February 11, 2019 07:33:06
+# created on...February 13, 2019 13:01:28
 
 # add some comments on how this version file
 # should be manually updated and used
 
 major = 6
 minor = 0
 micro = 3
-build = 59
-commit = 160
+build = 62
+commit = 163