docs(dfn): update information on when vertices and cell2d information…

… is required (#94) * Closes issue #52
MODFLOW-USGS · Feb 15, 2019 · 2e87182 · 2e87182
1 parent 737ca3b
commit 2e87182
Show file tree

Hide file tree

Showing 10 changed files with 14 additions and 12 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 70
+### Version 6.0.3 develop &mdash; build 72
 [![Build Status](https://travis-ci.org/MODFLOW-USGS/modflow6.svg?branch=develop)](https://travis-ci.org/MODFLOW-USGS/modflow6)
 
 ## Introduction

diff --git a/code.json b/code.json
@@ -18,7 +18,7 @@
             "email": "langevin@usgs.gov"
         }, 
         "laborHours": -1, 
-        "version": "6.0.3.70", 
+        "version": "6.0.3.72", 
         "date": {
             "metadataLastUpdated": "2019-02-15"
         }, 

diff --git a/doc/mf6io/gwf/binaryoutput.tex b/doc/mf6io/gwf/binaryoutput.tex
@@ -6,7 +6,7 @@
 
 \newpage
 \subsection{Binary Grid File}
-\mf~ writes a binary grid file that can be used for post processing model results.  The file name is assigned automatically by the program by adding ``.grb'' to the end of the discretization input file name.  The structure of the binary grid file depends on the type of discretization package that is used.  The following subsections summarize the binary grid file for the different grid types.  The red text in is not written to the binary grid file.
+\mf~writes a binary grid file that can be used for post processing model results.  The file structure was designed to be self-documenting so that it can evolve if necessary.  The file name is assigned automatically by the program by adding ``.grb'' to the end of the discretization input file name.  The structure of the binary grid file depends on the type of discretization package that is used.  The following subsections summarize the binary grid file for the different grid types.  The red text is not written to the binary grid file, but is shown here to explain the file content.
 
 \newpage
 \subsubsection{DIS Grids}
@@ -137,7 +137,7 @@ \subsubsection{DISV Grids}
 \newpage
 \subsubsection{DISU Grids}
 
-The binary grid file for DISU grids may contain information on the vertices and which vertices comprise a cell, but this depends on whether or not the user provided the information in the DISU Package.  This information is not required unless the XT3D option is used.  If provided, the x, y coordinates for each vertex are stored in the VERTICES array.  The list of vertices that comprise all of the cells is stored in the JAVERT array.  The list of vertices for any cell can be found using the IAVERT array.  Pseudocode for looping through cells in the grid is listed above in the section on the binary grid file for the DISV Package.  As for the DISV binary grid file, the list of vertices is ``closed'' for each cell in that the first listed vertex is equal to the last listed vertex.
+The binary grid file for DISU grids may contain information on the vertices and which vertices comprise a cell, but this depends on whether or not the user provided the information in the DISU Package.  This information is not required unless the XT3D or SAVE\_SPECIFIC\_DISCHARGE options are specified in the NPF Package.  If provided, the x, y coordinates for each vertex are stored in the VERTICES array.  The list of vertices that comprise all of the cells is stored in the JAVERT array.  The list of vertices for any cell can be found using the IAVERT array.  Pseudocode for looping through cells in the grid is listed above in the section on the binary grid file for the DISV Package.  As for the DISV binary grid file, the list of vertices is ``closed'' for each cell in that the first listed vertex is equal to the last listed vertex.
 
 \vspace{5mm}
 \noindent Header 1: \texttt{`GRID DISU'}  {\color{red} \footnotesize{CHARACTER(LEN=50)}} \\

diff --git a/doc/mf6io/gwf/disu.tex b/doc/mf6io/gwf/disu.tex
@@ -4,6 +4,8 @@
 
 The DISU Package does not support the concept of layers, which is different from the DISU implementation in MODFLOW-USG.  In \mf~all grid input and output for models that use the DISU Package is entered or written as a one-dimensional array of size nodes.
 
+The DISU VERTICES and CELL2D blocks are not required for all simulations.  These blocks are required if the XT3D or the SAVE\_SPECIFIC\_DISCHARGE options are specified in the NPF Package.  In general, it is recommended to include the VERTICES and CELL2D blocks. 
+
 \vspace{5mm}
 \subsubsection{Structure of Blocks}
 \lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwf-disu-options.dat}

diff --git a/doc/mf6io/mf6ivar/dfn/gwf-disu.dfn b/doc/mf6io/mf6ivar/dfn/gwf-disu.dfn
@@ -64,7 +64,7 @@ type integer
 reader urword
 optional true
 longname number of vertices
-description is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read.
+description is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read.  NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations.  If the XT3D or SAVE\_SPECIFIC\_DISCHARGE options are specified in the NPF Package, these this information is required.
 
 # --------------------- gwf disu griddata ---------------------
 

diff --git a/doc/mf6io/mf6ivar/md/mf6ivar.md b/doc/mf6io/mf6ivar/md/mf6ivar.md
@@ -124,7 +124,7 @@
 | GWF | DISU | OPTIONS | ANGROT | DOUBLE PRECISION | counter-clockwise rotation angle (in degrees) of the model grid coordinate system relative to a real-world coordinate system.  If not specified, then a default value of 0.0 is assigned.  The value for ANGROT does not affect the model simulation, but it is written to the binary grid file so that postprocessors can locate the grid in space. |
 | GWF | DISU | DIMENSIONS | NODES | INTEGER | is the number of cells in the model grid. |
 | GWF | DISU | DIMENSIONS | NJA | INTEGER | is the sum of the number of connections and NODES.  When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n.  Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells. |
-| GWF | DISU | DIMENSIONS | NVERT | INTEGER | is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read. |
+| GWF | DISU | DIMENSIONS | NVERT | INTEGER | is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read.  NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations.  If the XT3D or SAVE\_SPECIFIC\_DISCHARGE options are specified in the NPF Package, these this information is required. |
 | GWF | DISU | GRIDDATA | TOP | DOUBLE PRECISION (NODES) | is the top elevation for each cell in the model grid. |
 | GWF | DISU | GRIDDATA | BOT | DOUBLE PRECISION (NODES) | is the bottom elevation for each cell. |
 | GWF | DISU | GRIDDATA | AREA | DOUBLE PRECISION (NODES) | is the cell surface area (in plan view). |

diff --git a/doc/mf6io/mf6ivar/tex/gwf-disu-desc.tex b/doc/mf6io/mf6ivar/tex/gwf-disu-desc.tex
@@ -21,7 +21,7 @@
 
 \item \texttt{nja}---is the sum of the number of connections and NODES.  When calculating the total number of connections, the connection between cell n and cell m is considered to be different from the connection between cell m and cell n.  Thus, NJA is equal to the total number of connections, including n to m and m to n, and the total number of cells.
 
-\item \texttt{nvert}---is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read.
+\item \texttt{nvert}---is the total number of (x, y) vertex pairs used to define the plan-view shape of each cell in the model grid.  If NVERT is not specified or is specified as zero, then the VERTICES and CELL2D blocks below are not read.  NVERT and the accompanying VERTICES and CELL2D blocks should be specified for most simulations.  If the XT3D or SAVE\_SPECIFIC\_DISCHARGE options are specified in the NPF Package, these this information is required.
 
 \end{description}
 \item \textbf{Block: GRIDDATA}

diff --git a/doc/version.tex b/doc/version.tex
@@ -1,3 +1,3 @@
-\newcommand{\modflowversion}{mf6.0.3.70}
+\newcommand{\modflowversion}{mf6.0.3.72}
 \newcommand{\modflowdate}{February 15, 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.70 02/15/2019'
+  character(len=40), parameter :: VERSION = '6.0.3.72 02/15/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 15, 2019 13:36:06
+# created on...February 15, 2019 14:32:51
 
 # add some comments on how this version file
 # should be manually updated and used
 
 major = 6
 minor = 0
 micro = 3
-build = 70
-commit = 171
+build = 72
+commit = 173