docs(mf6io/ReleaseNotes): updates to describe changes for next release

* Closes MODFLOW-USGS#184.
* Add summary of issue MODFLOW-USGS#145 to ReleaseNotes
* Closes MODFLOW-USGS#141.

doc/ReleaseNotes/ReleaseNotes.tex

@@ -120,19 +120,20 @@ \section{History}
 \underline{BASIC FUNCTIONALITY}
 \begin{itemize}
 \item Added an error check to the DISU Package that ensures that an underlying cell has a top elevation that is less than or equal to the bottom of an overlying cell.  An underlying cell is one in which the IHC value for the connection is zero and the connecting node number is greater than the cell node number.
-\item --
+\item NPF Package will now write a message to the GWF Model list file to indicate when the SAVE\_SPECIFIC\_DISCHARGE option is invoked.
 \end{itemize}
 
 \underline{STRESS PACKAGES}
 \begin{itemize}
 \item There was an error in the calculation of the segmented evapotranspiration rate for the case where the rate did not decrease with depth.  There was another error in which PETM0 was being used as the evapotranspiration rate at the surface instead of the proportion of the evapotranspiration rate at the surface.
-\item --
+\item Corrected several error messages issued by the SFR Package that were not formatted correctly.  
 \end{itemize}
 
 \underline{ADVANCED STRESS PACKAGES}
 \begin{itemize}
 \item Corrected the way auxiliary variables are handled for the advanced packages.  In some cases, values for auxiliary variables were not being correctly written to the GWF Model budget file or to the advanced package budget file.  A consistent approach for updating and saving auxiliary variables was implemented for the MAW, SFR, LAK, and UZF Packages.
-\item --
+\item The user guide was updated to include a missing laksetting that was omitted from the PERIOD block.  The laksetting description now includes an INFLOW option; a description for INFLOW is also now included.
+\item For the advanced stress packages, values assigned to the auxiliary variables were not written correctly to the GWF Model budget file, but the values were correct in the advanced package budget file.  Program was modified so that auxiliary variables written to the GWF Model budget file are correct.
 \end{itemize}
 
 \underline{SOLUTION}

doc/mf6io/mf6ivar/dfn/gwf-lak.dfn

@@ -621,7 +621,7 @@ numeric_index true
 
 block period
 name laksetting
-type keystring status stage rainfall evaporation runoff withdrawal auxiliaryrecord
+type keystring status stage rainfall evaporation runoff inflow withdrawal auxiliaryrecord
 shape
 tagged false
 in_record true
@@ -683,6 +683,17 @@ time_series true
 longname runoff rate
 description real or character value that defines the runoff rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. 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.
 
+block period
+name inflow
+type string
+shape
+tagged true
+in_record true
+reader urword
+time_series true
+longname inflow rate
+description real or character value that defines the volumetric inflow rate $(L^3 T^{-1})$ for the lake. 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, inflow rates are zero for each lake.
+
 block period
 name withdrawal
 type string

doc/mf6io/mf6ivar/md/mf6ivar.md

@@ -5,6 +5,7 @@
 | SIM | NAM | OPTIONS | CONTINUE | KEYWORD | keyword flag to indicate that the simulation should continue even if one or more solutions do not converge. |
 | SIM | NAM | OPTIONS | NOCHECK | KEYWORD | keyword flag to indicate that the model input check routines should not be called prior to each time step. Checks are performed by default. |
 | SIM | NAM | OPTIONS | MEMORY_PRINT_OPTION | STRING | is a flag that controls printing of detailed memory manager usage to the end of the simulation list file.  NONE means do not print detailed information. SUMMARY means print only the total memory for each simulation component. ALL means print information for each variable stored in the memory manager. NONE is default if MEMORY\_PRINT\_OPTION is not specified. |
+| SIM | NAM | OPTIONS | MAXERRORS | INTEGER | maximum number of errors that will be stored and printed. |
 | SIM | NAM | TIMING | TDIS6 | STRING | is the name of the Temporal Discretization (TDIS) Input File. |
 | SIM | NAM | MODELS | MTYPE | STRING | is the type of model to add to simulation. |
 | SIM | NAM | MODELS | MFNAME | STRING | is the file name of the model name file. |
@@ -94,8 +95,8 @@
 | GWF | DIS | DIMENSIONS | NLAY | INTEGER | is the number of layers in the model grid. |
 | GWF | DIS | DIMENSIONS | NROW | INTEGER | is the number of rows in the model grid. |
 | GWF | DIS | DIMENSIONS | NCOL | INTEGER | is the number of columns in the model grid. |
-| GWF | DIS | GRIDDATA | DELR | DOUBLE PRECISION (NCOL) | is the is the column spacing in the row direction. |
-| GWF | DIS | GRIDDATA | DELC | DOUBLE PRECISION (NROW) | is the is the row spacing in the column direction. |
+| GWF | DIS | GRIDDATA | DELR | DOUBLE PRECISION (NCOL) | is the column spacing in the row direction. |
+| GWF | DIS | GRIDDATA | DELC | DOUBLE PRECISION (NROW) | is the row spacing in the column direction. |
 | GWF | DIS | GRIDDATA | TOP | DOUBLE PRECISION (NCOL, NROW) | is the top elevation for each cell in the top model layer. |
 | GWF | DIS | GRIDDATA | BOTM | DOUBLE PRECISION (NCOL, NROW, NLAY) | is the bottom elevation for each cell. |
 | GWF | DIS | GRIDDATA | IDOMAIN | INTEGER (NCOL, NROW, NLAY) | is an optional array that characterizes the existence status of a cell.  If the IDOMAIN array is not specified, then all model cells exist within the solution.  If the IDOMAIN value for a cell is 0, the cell does not exist in the simulation.  Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution.  If the IDOMAIN value for a cell is 1, the cell exists in the simulation.  If the IDOMAIN value for a cell is -1, the cell does not exist in the simulation.  Furthermore, the first existing cell above will be connected to the first existing cell below.  This type of cell is referred to as a ``vertical pass through'' cell. |
@@ -125,7 +126,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.  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 | 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, then 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). |
@@ -319,7 +320,7 @@
 | GWF | EVT | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. |
 | GWF | EVT | OPTIONS | OBS6 | KEYWORD | keyword to specify that record corresponds to an observations file. |
 | GWF | EVT | OPTIONS | OBS6_FILENAME | STRING | name of input file to define observations for the Evapotranspiration package. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:obstype} lists observation type(s) supported by the Evapotranspiration package. |
-| GWF | EVT | OPTIONS | SURF_RATE_SPECIFIED | KEYWORD | indicates that the evapotranspiration rate at the ET surface will be specified as PETM0 in list input. |
+| GWF | EVT | OPTIONS | SURF_RATE_SPECIFIED | KEYWORD | indicates that the proportion of the evapotranspiration rate at the ET surface will be specified as PETM0 in list input. |
 | GWF | EVT | DIMENSIONS | MAXBOUND | INTEGER | integer value specifying the maximum number of evapotranspiration cells cells that will be specified for use during any stress period. |
 | GWF | EVT | DIMENSIONS | NSEG | INTEGER | number of ET segments.  Default is one.  When NSEG is greater than 1, PXDP and PETM arrays must be specified NSEG - 1 times each, in order from the uppermost segment down. PXDP defines the extinction-depth proportion at the bottom of a segment. PETM defines the proportion of the maximum ET flux rate at the bottom of a segment. |
 | GWF | EVT | PERIOD | IPER | INTEGER | integer value specifying the starting stress period number for which the data specified in the PERIOD block apply.  IPER must be less than or equal to NPER in the TDIS Package and greater than zero.  The IPER value assigned to a stress period block must be greater than the IPER value assigned for the previous PERIOD block.  The information specified in the PERIOD block will continue to apply for all subsequent stress periods, unless the program encounters another PERIOD block. |
@@ -522,6 +523,7 @@
 | GWF | LAK | PERIOD | RAINFALL | STRING | real or character value that defines the rainfall rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. 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. |
 | GWF | LAK | PERIOD | EVAPORATION | STRING | real or character value that defines the maximum evaporation rate $(LT^{-1})$ for the lake. Value must be greater than or equal to zero. 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. |
 | GWF | LAK | PERIOD | RUNOFF | STRING | real or character value that defines the runoff rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. 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. |
+| GWF | LAK | PERIOD | INFLOW | STRING | real or character value that defines the volumetric inflow rate $(L^3 T^{-1})$ for the lake. 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, inflow rates are zero for each lake. |
 | GWF | LAK | PERIOD | WITHDRAWAL | STRING | real or character value that defines the maximum withdrawal rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. 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. |
 | GWF | LAK | PERIOD | AUXILIARY | KEYWORD | keyword for specifying auxiliary variable. |
 | GWF | LAK | PERIOD | AUXNAME | STRING | name for the auxiliary variable to be assigned AUXVAL.  AUXNAME must match one of the auxiliary variable names defined in the OPTIONS block. If AUXNAME does not match one of the auxiliary variable names defined in the OPTIONS block the data are ignored. |

doc/mf6io/mf6ivar/tex/gwf-dis-desc.tex

@@ -27,9 +27,9 @@
 \item \textbf{Block: GRIDDATA}
 
 \begin{description}
-\item \texttt{delr}---is the is the column spacing in the row direction.
+\item \texttt{delr}---is the column spacing in the row direction.
 
-\item \texttt{delc}---is the is the row spacing in the column direction.
+\item \texttt{delc}---is the row spacing in the column direction.
 
 \item \texttt{top}---is the top elevation for each cell in the top model layer.
 

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.  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.
+\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, then this information is required.
 
 \end{description}
 \item \textbf{Block: GRIDDATA}

doc/mf6io/mf6ivar/tex/gwf-evt-desc.tex

@@ -27,7 +27,7 @@
 
 \item \texttt{obs6\_filename}---name of input file to define observations for the Evapotranspiration package. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:obstype} lists observation type(s) supported by the Evapotranspiration package.
 
-\item \texttt{SURF\_RATE\_SPECIFIED}---indicates that the evapotranspiration rate at the ET surface will be specified as PETM0 in list input.
+\item \texttt{SURF\_RATE\_SPECIFIED}---indicates that the proportion of the evapotranspiration rate at the ET surface will be specified as PETM0 in list input.
 
 \end{description}
 \item \textbf{Block: DIMENSIONS}

doc/mf6io/mf6ivar/tex/gwf-lak-desc.tex

@@ -137,6 +137,7 @@
 RAINFALL <@rainfall@>
 EVAPORATION <@evaporation@>
 RUNOFF <@runoff@>
+INFLOW <@inflow@>
 WITHDRAWAL <@withdrawal@>
 AUXILIARY <auxname> <@auxval@> 
 \end{lstlisting}
@@ -151,6 +152,8 @@
 
 \item \textcolor{blue}{\texttt{runoff}---real or character value that defines the runoff rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. 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.}
 
+\item \textcolor{blue}{\texttt{inflow}---real or character value that defines the volumetric inflow rate $(L^3 T^{-1})$ for the lake. 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, inflow rates are zero for each lake.}
+
 \item \textcolor{blue}{\texttt{withdrawal}---real or character value that defines the maximum withdrawal rate $(L^3 T^{-1})$ for the lake. Value must be greater than or equal to zero. 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.}
 
 \item \texttt{AUXILIARY}---keyword for specifying auxiliary variable.

doc/mf6io/mf6ivar/tex/sim-nam-desc.tex

@@ -9,6 +9,8 @@
 
 \item \texttt{memory\_print\_option}---is a flag that controls printing of detailed memory manager usage to the end of the simulation list file.  NONE means do not print detailed information. SUMMARY means print only the total memory for each simulation component. ALL means print information for each variable stored in the memory manager. NONE is default if MEMORY\_PRINT\_OPTION is not specified.
 
+\item \texttt{maxerrors}---maximum number of errors that will be stored and printed.
+
 \end{description}
 \item \textbf{Block: TIMING}
 

doc/mf6io/mf6ivar/tex/sim-nam-options.dat

@@ -2,4 +2,5 @@ BEGIN OPTIONS
   [CONTINUE]
   [NOCHECK]
   [MEMORY_PRINT_OPTION <memory_print_option>]
+  [MAXERRORS <maxerrors>]
 END OPTIONS

src/Model/GroundWaterFlow/gwf3npf8.f90

@@ -1295,8 +1295,11 @@ subroutine read_options(this)
           case ('SAVE_SPECIFIC_DISCHARGE')
             this%icalcspdis = 1
             this%isavspdis = 1
+            write(this%iout,'(4x,a)')                                          &
+              'SPECIFIC DISCHARGE WILL BE CALCULATED AT CELL CENTERS ' //      &
+              'AND WRITTEN TO DATA-SPDIS IN BUDGET FILE WHEN REQUESTED.'
           !
-          ! -- right now these are options that are only available in the
+          ! -- The following are options that are only available in the
           !    development version and are not included in the documentation.
           !    These options are only available when IDEVELOPMODE in
           !    constants module is set to 1

src/Utilities/InputOutput.f90

@@ -638,7 +638,7 @@ subroutine UWWORD(LINE,ICOL,ILEN,NCODE,C,N,R,FMT,CENTER,LEFT,SEP)
             write(cfmt, '(A,I0,A)') '(I', ILEN, ')'
           case(3)
             i = ILEN - 7
-            write(cfmt, '(A,I0,A,I0,A)') '(G', ILEN, '.', i, ')'
+            write(cfmt, '(A,I0,A,I0,A)') '(1X,G', ILEN - 1, '.', i, ')'
         end select
       end if
 
@@ -674,7 +674,7 @@ subroutine UWWORD(LINE,ICOL,ILEN,NCODE,C,N,R,FMT,CENTER,LEFT,SEP)
         end if
       end if
 
-      istop = ICOL + ILEN
+      istop = ICOL + ILEN - 1
 
       select case(NCODE)
         case(0, 1)
@@ -685,7 +685,7 @@ subroutine UWWORD(LINE,ICOL,ILEN,NCODE,C,N,R,FMT,CENTER,LEFT,SEP)
           write(LINE(ICOL:istop), cfmt) R
       end select
 
-      ICOL = istop
+      ICOL = istop + 1
 
       if (present(SEP)) then
         i = len(SEP)