From 6fca5e60138a54a217cf1f951dbaa8ef2df452a3 Mon Sep 17 00:00:00 2001 From: langevin-usgs Date: Tue, 21 May 2024 11:49:28 -0500 Subject: [PATCH] docs(releasenotes): more cleanup for 6.5.0 release (#1838) * docs(releasenotes): more cleanup for 6.5.0 release * fix ftype table links in mf6io --- doc/ReleaseNotes/ReleaseNotes.tex | 7 +- doc/SuppTechInfo/mf6suptechinfo.bbl | 105 +++++++++++++++++++------ doc/mf6io/gwe/namefile.tex | 2 +- doc/mf6io/gwf/namefile.tex | 2 +- doc/mf6io/gwt/namefile.tex | 2 +- doc/mf6io/mf6ivar/dfn/gwe-est.dfn | 4 +- doc/mf6io/mf6ivar/dfn/gwe-nam.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwf-nam.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwt-nam.dfn | 2 +- doc/mf6io/mf6ivar/dfn/prt-nam.dfn | 2 +- doc/mf6io/mf6ivar/dfn/swf-nam.dfn | 2 +- doc/mf6io/mf6ivar/md/mf6ivar.md | 18 ++--- doc/mf6io/mf6ivar/tex/gwe-est-desc.tex | 4 +- doc/mf6io/mf6ivar/tex/gwe-nam-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/gwf-nam-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/gwt-nam-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/prt-nam-desc.tex | 2 +- doc/mf6io/mf6ivar/tex/prt-prp-desc.tex | 4 +- doc/mf6io/mf6ivar/tex/swf-nam-desc.tex | 2 +- doc/mf6io/prt/namefile.tex | 2 +- doc/mf6io/swf/namefile.tex | 2 +- 21 files changed, 113 insertions(+), 59 deletions(-) diff --git a/doc/ReleaseNotes/ReleaseNotes.tex b/doc/ReleaseNotes/ReleaseNotes.tex index c8d3cce6157..17b5a209871 100644 --- a/doc/ReleaseNotes/ReleaseNotes.tex +++ b/doc/ReleaseNotes/ReleaseNotes.tex @@ -202,7 +202,7 @@ \section{Known Issues and Incompatibilities} \begin{enumerate} \item -The READARRAY utility is used by some packages to read arrays of numeric values provided by the user. The READARRAY utility has an IPRN option (as described in the MODFLOW 6 Description of Input and Output), which will cause the array to be written to the model listing file. Support for the IPRN option has been removed for some packages and will ultimately be removed for all packages. An alternative for IPRN functionality is presently under development. +The READARRAY utility is used by some packages to read arrays of numeric values provided by the user. The READARRAY utility has an IPRN option (as described in the MODFLOW 6 Description of Input and Output), which will cause the array to be written to the model listing file. Support for the IPRN option has been removed for some packages and will ultimately be removed for all packages. A new option, called ``EXPORT\_ARRAY\_ASCII'' has been implemented for some packages to support writing of gridded data to external text files. This option has been implemented to replace the IPRN functionality. \item The capability to use Unsaturated Zone Flow (UZF) routing beneath lakes and streams has not been implemented. @@ -235,10 +235,7 @@ \section{Known Issues and Incompatibilities} % ------------------------------------------------- \section{Distribution File} -The following distribution file is for use on personal computers: \texttt{\modflowversion\_[ostag].zip}. The distribution file is a compressed zip file. The following directory structure is incorporated in the zip file: - -% folder structured created by python script -\input{folder_struct.tex} +The distribution is provided in the form of a compressed zip file. Distributions are available for several different operating systems, including Windows, Mac, and Linux. Distributions are marked with an operating system tag, called ``ostag''. Values for ``ostag'' include ``win64'', ``mac'', and ``linux'', for example. Distribution files for this release are labeled as \texttt{\modflowversion\_[ostag].zip}. Thus, the distribution file for Windows for this release is \texttt{\modflowversion\_win64.zip}. It is recommended that no user files are kept in the release directory. If you do plan to put your own files in the release directory, do so only by creating additional subdirectories. diff --git a/doc/SuppTechInfo/mf6suptechinfo.bbl b/doc/SuppTechInfo/mf6suptechinfo.bbl index deed854f368..c94fb8b58c9 100644 --- a/doc/SuppTechInfo/mf6suptechinfo.bbl +++ b/doc/SuppTechInfo/mf6suptechinfo.bbl @@ -1,22 +1,52 @@ -\begin{thebibliography}{21} +\begin{thebibliography}{30} \providecommand{\natexlab}[1]{#1} \expandafter\ifx\csname urlstyle\endcsname\relax - \providecommand{\doi}[1]{doi:\discretionary{}{}{}#1}\else - \providecommand{\doi}{doi:\discretionary{}{}{}\begingroup + \providecommand{\doiagency}[1]{doi:\discretionary{}{}{}#1}\else + \providecommand{\doiagency}{doi:\discretionary{}{}{}\begingroup \urlstyle{rm}\Url}\fi +\bibitem[{Bakker and others(2016)Bakker, Post, Langevin, Hughes, White, Starn, + and Fienen}]{bakker2016flopy} +Bakker, M., Post, V., Langevin, C.D., Hughes, J.D., White, J.T., Starn, J.J., + and Fienen, M.N., 2016, Scripting modflow model development using python and + flopy: Groundwater, \url{https://doi.org/https://doi.org/10.1111/gwat.12413}. + +\bibitem[{Bakker and others(2024)Bakker, Post, Hughes, Langevin, White, Leaf, + Paulinski, Bellino, Morway, Toews, Larsen, Fienen, Starn, Brenhoff, and + Bonelli}]{flopysoftware} +Bakker, M., Post, V., Hughes, J.D., Langevin, C.D., White, J.T., Leaf, A.T., + Paulinski, S.R., Bellino, J.C., Morway, E.D., Toews, M.W., Larsen, J.D., + Fienen, M.N., Starn, J.J., Brenhoff, D.A., and Bonelli, W.P., 2024, FloPy + v3.7.0dev0 (preliminary): {U.S. Geological Survey Software Release}, + \url{https://doi.org/10.5066/F7BK19FH}. + +\bibitem[{Bedekar and others(2016)Bedekar, Morway, Langevin, and + Tonkin}]{mt3dusgs} +Bedekar, V., Morway, E.D., Langevin, C.D., and Tonkin, M.J., 2016, MT3D-USGS + version 1: A U.S. Geological Survey release of MT3DMS updated with new and + expanded transport capabilities for use with MODFLOW: {U.S. Geological Survey + Techniques and Methods, book 6, chap. A53, 69 p.}, + \url{https://doi.org/10.3133/tm6a53}, \url{http://dx.doi.org/10.3133/tm6A53}. + \bibitem[{Campbell and others(1994)Campbell, Jungbauer, Bidlake, and Hungerford}]{campbell1994} Campbell, G.S., Jungbauer, J.D., Bidlake, W.R., and Hungerford, R.D., 1994, Predicting the effect of temperature on soil thermal conductivity: Soil Science, v. 158, no.~5, p.~307--313. +\bibitem[{Cordes and Kinzelbach(1992)}]{cordes1992} +Cordes, C., and Kinzelbach, W., 1992, Continuous groundwater velocity fields + and path lines in linear, bilinear, and trilinear finite elements: Water + Resources Research, v.~28, p.~2903--2911, + \url{https://doi.org/10.1029/92WR01686}. + \bibitem[{Guo and Langevin(2002)}]{langevin2002seawat} -Guo, Weixing, and Langevin, C.D., 2002, User's Guide to SEAWAT: A Computer - Program for Simulation of Three-Dimensional Variable-Density Ground-Water - Flow: {U.S. Geological Survey Techniques of Water-Resources Investigations - book 6, Chapter A7, 77 p.}, accessed July 25, 2019, at - \url{https://pubs.er.usgs.gov/publication/ofr03426}. +Guo, W., and Langevin, C.D., 2002, User's Guide to SEAWAT: A Computer Program + for Simulation of Three-Dimensional Variable-Density Ground-Water Flow: {U.S. + Geological Survey Techniques of Water-Resources Investigations book 6, + Chapter A7, 77 p.}, accessed July 25, 2019, at + \url{https://doi.org/https://doi.org/10.3133/twri06A7}, at + \url{https://pubs.usgs.gov/publication/twri06A7}. \bibitem[{Harbaugh(2005)}]{modflow2005} Harbaugh, A.W., 2005, MODFLOW-2005, the U.S. Geological Survey modular @@ -52,9 +82,16 @@ Hughes, J.D., Langevin, C.D., and Banta, E.R., 2017, Documentation for the MODFLOW 6 framework: {U.S. Geological Survey Techniques and Methods, book 6, chap. A57, 36 p.}, \url{https://doi.org/10.3133/tm6A57}. +\bibitem[{Hughes and others(2024)Hughes, Langevin, Paulinski, Larsen, and + Brakenhoff}]{hughes2023flopy} +Hughes, J.D., Langevin, C.D., Paulinski, S.R., Larsen, J.D., and Brakenhoff, + D., 2024, {FloPy} workflows for creating structured and unstructured + {MODFLOW} models: Groundwater, v.~62, no.~1, p.~124--139, + \url{https://doi.org/10.1111/gwat.13327}. + \bibitem[{Kavetski and Kuczera(2007)}]{doi:10.1029/2006WR005195} -Kavetski, Dmitri, and Kuczera, George, 2007, Model smoothing strategies to - remove microscale discontinuities and spurious secondary optima in objective +Kavetski, D., and Kuczera, G., 2007, Model smoothing strategies to remove + microscale discontinuities and spurious secondary optima in objective functions in hydrological calibration: Water Resources Research, v.~43, no.~3, \url{https://doi.org/10.1029/2006WR005195}, \url{https://agupubs.onlinelibrary.wiley.com/doi/abs/10.1029/2006WR005195}. @@ -67,8 +104,8 @@ Kipp, K.L., 1987, HST3D: A Computer Code for Simulation of Heat and Solute \bibitem[{Langevin and others(2008)Langevin, Thorne~Jr, Dausman, Sukop, and Guo}]{langevin2008seawat} -Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, Weixing, - 2008, {SEAWAT} Version 4---A computer program for simulation of multi-species +Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, W., 2008, + {SEAWAT} Version 4---A computer program for simulation of multi-species solute and heat transport: {U.S. Geological Survey Techniques and Methods, book 6, chap. A22, 39 p.}, accessed June 27, 2017, at \url{https://pubs.er.usgs.gov/publication/tm6A22}. @@ -76,21 +113,21 @@ Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, Weixing, \bibitem[{Langevin and others(2017)Langevin, Hughes, Provost, Banta, Niswonger, and Panday}]{modflow6gwf} Langevin, C.D., Hughes, J.D., Provost, A.M., Banta, E.R., Niswonger, R.G., and - Panday, Sorab, 2017, Documentation for the MODFLOW 6 Groundwater Flow (GWF) + Panday, S., 2017, Documentation for the MODFLOW 6 Groundwater Flow (GWF) Model: {U.S. Geological Survey Techniques and Methods, book 6, chap. A55, 197 p.}, \url{https://doi.org/10.3133/tm6A55}. \bibitem[{Langevin and others(2022)Langevin, Provost, Panday, and Hughes}]{modflow6gwt} -Langevin, C.D., Provost, A.M., Panday, Sorab, and Hughes, J.D., 2022, +Langevin, C.D., Provost, A.M., Panday, S., and Hughes, J.D., 2022, Documentation for the MODFLOW 6 Groundwater Transport (GWT) Model: {U.S. Geological Survey Techniques and Methods, book 6, chap. A61, 56 p.}, \url{https://doi.org/10.3133/tm6A61}. \bibitem[{Ma and Zheng(2010)}]{mazheng2010} -Ma, Rui, and Zheng, Chunmiao, 2010, Effects of density and viscosity in - modeling heat as a groundwater tracer: Groundwater, v.~48, no.~3, - p.~380--389, \url{https://doi.org/10.1111/j.1745-6584.2009.00660.x}. +Ma, R., and Zheng, C., 2010, Effects of density and viscosity in modeling heat + as a groundwater tracer: Groundwater, v.~48, no.~3, p.~380--389, + \url{https://doi.org/10.1111/j.1745-6584.2009.00660.x}. \bibitem[{Maidment(1993)}]{maidment1993} Maidment, D.R., 1993, Handbook of Hydrology: New York, USA, McGraw-Hill. @@ -103,15 +140,30 @@ Markle, J.M., Schincariol, R.A., Sass, J.H., and Molson, J.W., 2006, no.~4, p.~1281--1294, \url{https://doi.org/https://doi.org/10.2136/sssaj2005.0293}. +\bibitem[{Panday(2019)}]{panday2019bct} +Panday, S., 2019, USG-Transport Version 1.4.0: The Block-Centered Transport + Process for MODFLOW-USG: , + \url{http://gmsdocs.aquaveo.com.s3.amazonaws.com/GWT_v1-4-0.pdf}. + \bibitem[{Panday and others(2013)Panday, Langevin, Niswonger, Ibaraki, and Hughes}]{modflowusg} -Panday, Sorab, Langevin, C.D., Niswonger, R.G., Ibaraki, Motomu, and Hughes, - J.D., 2013, MODFLOW-USG version 1---An unstructured grid version of MODFLOW - for simulating groundwater flow and tightly coupled processes using a control +Panday, S., Langevin, C.D., Niswonger, R.G., Ibaraki, M., and Hughes, J.D., + 2013, MODFLOW-USG version 1---An unstructured grid version of MODFLOW for + simulating groundwater flow and tightly coupled processes using a control volume finite-difference formulation: {U.S. Geological Survey Techniques and Methods, book 6, chap. A45, 66 p.}, accessed June 27, 2017, at \url{https://pubs.usgs.gov/tm/06/a45/}. +\bibitem[{Pollock(2015)}]{pollock2015} +Pollock, D.W., 2015, Extending the modpath algorithm to rectangular + unstructured grids: Groundwater, v.~54, p.~121--125, + \url{https://doi.org/10.1111/gwat.12328}. + +\bibitem[{Pollock(2016)}]{pollock2016modpath7} +Pollock, D.W., 2016, User guide for MODPATH Version 7---A particle-tracking + model for MODFLOW: {U.S. Geological Survey Open-File Report 2016--1086, 35 + p.}, accessed June 27, 2017, at \url{https://doi.org/10.3133/ofr20161086}. + \bibitem[{Provost and others(2017)Provost, Langevin, and Hughes}]{modflow6xt3d} Provost, A.M., Langevin, C.D., and Hughes, J.D., 2017, Documentation for the ``XT3D'' Option in the Node Property Flow (NPF) Package of MODFLOW 6: {U.S. @@ -119,7 +171,7 @@ Provost, A.M., Langevin, C.D., and Hughes, J.D., 2017, Documentation for the \url{https://doi.org/10.3133/tm6A56}. \bibitem[{Thorne and others(2006)Thorne, Langevin, and Sukop}]{thorne2006} -Thorne, Danny, Langevin, C.D., and Sukop, M.C., 2006, Addition of simultaneous +Thorne, D., Langevin, C.D., and Sukop, M.C., 2006, Addition of simultaneous heat and solute transport and variable fluid viscosity to seawat: Computers and Geosciences, v.~32, no.~10, p.~1758--1768, \url{https://doi.org/https://doi.org/10.1016/j.cageo.2006.04.005}. @@ -130,12 +182,17 @@ Voss, C.I., 1984, SUTRA---A finite-element simulation model for transport or chemically-reactive single-species solute transport: {U.S. Geological Survey Water-Resources Investigations Report 84--4369, 409 p.} +\bibitem[{Zhang and others(2012)Zhang, King, and Datta-Gupta}]{zhang2012} +Zhang, Y., King, M.J., and Datta-Gupta, A., 2012, Robust streamline tracing + using inter-cell fluxes in locally refined and unstructured grids: Water + Resources Research, v.~48, \url{https://doi.org/10.1029/2011WR011396}. + \bibitem[{Zheng(2010)}]{zheng2010supplemental} -Zheng, Chunmiao, 2010, MT3DMS v5.3, Supplemental User's Guide: {Technical - Report Prepared for the U.S. Army Corps of Engineers, 51 p.} +Zheng, C., 2010, MT3DMS v5.3, Supplemental User's Guide: {Technical Report + Prepared for the U.S. Army Corps of Engineers, 51 p.} \bibitem[{Zheng and Wang(1999)}]{zheng1999mt3dms} -Zheng, Chunmiao, and Wang, P.P., 1999, MT3DMS---A modular three-dimensional +Zheng, C., and Wang, P.P., 1999, MT3DMS---A modular three-dimensional multi-species transport model for simulation of advection, dispersion and chemical reactions of contaminants in groundwater systems; Documentation and user's guide: {Contract report SERDP--99--1: Vicksburg, Miss., U.S. Army diff --git a/doc/mf6io/gwe/namefile.tex b/doc/mf6io/gwe/namefile.tex index 1f8ed8ba7b1..92bdb13f5ee 100644 --- a/doc/mf6io/gwe/namefile.tex +++ b/doc/mf6io/gwe/namefile.tex @@ -41,7 +41,7 @@ \subsubsection{Explanation of Variables} OBS6 & Observations Option \\ \hline \end{tabular*} -\label{table:ftype} +\label{table:ftype-gwe} \end{center} \normalsize \end{table} diff --git a/doc/mf6io/gwf/namefile.tex b/doc/mf6io/gwf/namefile.tex index f54f1ee1e5f..44626885961 100644 --- a/doc/mf6io/gwf/namefile.tex +++ b/doc/mf6io/gwf/namefile.tex @@ -49,7 +49,7 @@ \subsubsection{Explanation of Variables} OBS6 & Observations Option \\ \hline \end{tabular*} -\label{table:ftype} +\label{table:ftype-gwf} \end{center} \normalsize \end{table} diff --git a/doc/mf6io/gwt/namefile.tex b/doc/mf6io/gwt/namefile.tex index 8835e18db77..4fcd5acde0b 100644 --- a/doc/mf6io/gwt/namefile.tex +++ b/doc/mf6io/gwt/namefile.tex @@ -43,7 +43,7 @@ \subsubsection{Explanation of Variables} OBS6 & Observations Option \\ \hline \end{tabular*} -\label{table:ftype} +\label{table:ftype-gwt} \end{center} \normalsize \end{table} diff --git a/doc/mf6io/mf6ivar/dfn/gwe-est.dfn b/doc/mf6io/mf6ivar/dfn/gwe-est.dfn index a31e9a45697..22181237c3e 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-est.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-est.dfn @@ -61,7 +61,7 @@ shape (nodes) reader readarray layered true longname density of aquifer material -description is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. +description is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. # --------------------- gwe est packagedata --------------------- @@ -91,7 +91,7 @@ tagged false in_record true reader urword longname density of water -description is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. +description is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. block packagedata diff --git a/doc/mf6io/mf6ivar/dfn/gwe-nam.dfn b/doc/mf6io/mf6ivar/dfn/gwe-nam.dfn index 70c89d67135..31aa8fd84b5 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-nam.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-nam.dfn @@ -50,7 +50,7 @@ type string tagged false reader urword longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase. block packages name fname diff --git a/doc/mf6io/mf6ivar/dfn/gwf-nam.dfn b/doc/mf6io/mf6ivar/dfn/gwf-nam.dfn index b363bca2eca..f4e6ba4839f 100644 --- a/doc/mf6io/mf6ivar/dfn/gwf-nam.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwf-nam.dfn @@ -75,7 +75,7 @@ type string tagged false reader urword longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase. block packages name fname diff --git a/doc/mf6io/mf6ivar/dfn/gwt-nam.dfn b/doc/mf6io/mf6ivar/dfn/gwt-nam.dfn index cc68d510f30..a06795e2439 100644 --- a/doc/mf6io/mf6ivar/dfn/gwt-nam.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwt-nam.dfn @@ -50,7 +50,7 @@ type string tagged false reader urword longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase. block packages name fname diff --git a/doc/mf6io/mf6ivar/dfn/prt-nam.dfn b/doc/mf6io/mf6ivar/dfn/prt-nam.dfn index e2c5e70e43e..5dc5084c23b 100644 --- a/doc/mf6io/mf6ivar/dfn/prt-nam.dfn +++ b/doc/mf6io/mf6ivar/dfn/prt-nam.dfn @@ -49,7 +49,7 @@ type string tagged false reader urword longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase. block packages name fname diff --git a/doc/mf6io/mf6ivar/dfn/swf-nam.dfn b/doc/mf6io/mf6ivar/dfn/swf-nam.dfn index 386b00cb261..77fcbcd8ab2 100644 --- a/doc/mf6io/mf6ivar/dfn/swf-nam.dfn +++ b/doc/mf6io/mf6ivar/dfn/swf-nam.dfn @@ -75,7 +75,7 @@ type string tagged false reader urword longname package type -description is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +description is the file type, which must be one of the following character values shown in table~\ref{table:ftype-swf}. Ftype may be entered in any combination of uppercase and lowercase. block packages name fname diff --git a/doc/mf6io/mf6ivar/md/mf6ivar.md b/doc/mf6io/mf6ivar/md/mf6ivar.md index 10cf4b62ebe..c0f5f10b2cf 100644 --- a/doc/mf6io/mf6ivar/md/mf6ivar.md +++ b/doc/mf6io/mf6ivar/md/mf6ivar.md @@ -281,9 +281,9 @@ | GWE | EST | GRIDDATA | POROSITY | DOUBLE PRECISION (NODES) | is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume. The GWE model does not support the concept of an immobile domain in the context of heat transport. | | GWE | EST | GRIDDATA | DECAY | DOUBLE PRECISION (NODES) | is the rate coefficient for zero-order decay for the aqueous phase of the mobile domain. A negative value indicates heat (energy) production. The dimensions of decay for zero-order decay is energy per length cubed per time. Zero-order decay will have no effect on simulation results unless zero-order decay is specified in the options block. | | GWE | EST | GRIDDATA | CPS | DOUBLE PRECISION (NODES) | is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent). | -| GWE | EST | GRIDDATA | RHOS | DOUBLE PRECISION (NODES) | is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. | +| GWE | EST | GRIDDATA | RHOS | DOUBLE PRECISION (NODES) | is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. | | GWE | EST | PACKAGEDATA | CPW | DOUBLE PRECISION | is the mass-based heat capacity of the simulated fluid. For example, units of J/kg/C may be used (or equivalent). | -| GWE | EST | PACKAGEDATA | RHOW | DOUBLE PRECISION | is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. | +| GWE | EST | PACKAGEDATA | RHOW | DOUBLE PRECISION | is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. | | GWE | EST | PACKAGEDATA | LATHEATVAP | DOUBLE PRECISION | is the user-specified value for the latent heat of vaporization. For example, if working in SI units, values may be entered as kJ/kg. | | GWE | FMI | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that FMI flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | | GWE | FMI | OPTIONS | FLOW_IMBALANCE_CORRECTION | KEYWORD | correct for an imbalance in flows by assuming that any residual flow error comes in or leaves at the temperature of the cell. When this option is activated, the GWE Model budget written to the listing file will contain two additional entries: FLOW-ERROR and FLOW-CORRECTION. These two entries will be equal but opposite in sign. The FLOW-CORRECTION term is a mass flow that is added to offset the error caused by an imprecise flow balance. If these terms are not relatively small, the flow model should be rerun with stricter convergence tolerances. | @@ -377,7 +377,7 @@ | GWE | NAM | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read. | | GWE | NAM | OPTIONS | PRINT_FLOWS | KEYWORD | keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which ``BUDGET PRINT'' is specified in Output Control. If there is no Output Control option and ``PRINT\_FLOWS'' is specified, then flow rates are printed for the last time step of each stress period. | | GWE | NAM | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that all model package flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | -| GWE | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. | +| GWE | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase. | | GWE | NAM | PACKAGES | FNAME | STRING | is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. | | GWE | NAM | PACKAGES | PNAME | STRING | is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWE Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters. | | GWE | OC | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. | @@ -907,7 +907,7 @@ | GWF | NAM | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that all model package flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | | GWF | NAM | OPTIONS | NEWTON | KEYWORD | keyword that activates the Newton-Raphson formulation for groundwater flow between connected, convertible groundwater cells and stress packages that support calculation of Newton-Raphson terms for groundwater exchanges. Cells will not dry when this option is used. By default, the Newton-Raphson formulation is not applied. | | GWF | NAM | OPTIONS | UNDER_RELAXATION | KEYWORD | keyword that indicates whether the groundwater head in a cell will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER\_RELAXATION is not applied. | -| GWF | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. | +| GWF | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase. | | GWF | NAM | PACKAGES | FNAME | STRING | is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. | | GWF | NAM | PACKAGES | PNAME | STRING | is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters. | | GWF | NPF | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that budget flow terms will be written to the file specified with ``BUDGET SAVE FILE'' in Output Control. | @@ -1411,7 +1411,7 @@ | GWT | NAM | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read. | | GWT | NAM | OPTIONS | PRINT_FLOWS | KEYWORD | keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which ``BUDGET PRINT'' is specified in Output Control. If there is no Output Control option and ``PRINT\_FLOWS'' is specified, then flow rates are printed for the last time step of each stress period. | | GWT | NAM | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that all model package flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | -| GWT | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. | +| GWT | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase. | | GWT | NAM | PACKAGES | FNAME | STRING | is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. | | GWT | NAM | PACKAGES | PNAME | STRING | is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single GWT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters. | | GWT | OC | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. | @@ -1579,7 +1579,7 @@ | PRT | NAM | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read. | | PRT | NAM | OPTIONS | PRINT_FLOWS | KEYWORD | keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which ``BUDGET PRINT'' is specified in Output Control. If there is no Output Control option and ``PRINT\_FLOWS'' is specified, then flow rates are printed for the last time step of each stress period. | | PRT | NAM | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that all model package flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | -| PRT | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. | +| PRT | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase. | | PRT | NAM | PACKAGES | FNAME | STRING | is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. | | PRT | NAM | PACKAGES | PNAME | STRING | is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single PRT Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters. | | PRT | OC | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. | @@ -1627,9 +1627,9 @@ | PRT | PRP | OPTIONS | ISTOPZONE | INTEGER | integer value defining the stop zone number. If cells have been assigned IZONE values in the GRIDDATA block, a particle terminates if it enters a cell whose IZONE value matches ISTOPZONE. An ISTOPZONE value of zero indicates that there is no stop zone. The default value is zero. | | PRT | PRP | OPTIONS | DRAPE | KEYWORD | is a text keyword to indicate that if a particle's release point is in a cell that happens to be inactive at release time, the particle is to be moved to the topmost active cell below it, if any. By default, a particle is not released into the simulation if its release point's cell is inactive at release time. | | PRT | PRP | OPTIONS | RELEASE_TIMES | KEYWORD | keyword indicating release times will follow | -| PRT | PRP | OPTIONS | TIMES | DOUBLE PRECISION (UNKNOWN) | times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. Explicit release times and release settings configured in the period block are additive and can be mixed and matched. | +| PRT | PRP | OPTIONS | TIMES | DOUBLE PRECISION (UNKNOWN) | times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. | | PRT | PRP | OPTIONS | RELEASE_TIMESFILE | KEYWORD | keyword indicating release times file name will follow | -| PRT | PRP | OPTIONS | TIMESFILE | STRING | name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. Explicit release times and release settings configured in the period block are additive and can be mixed and matched. | +| PRT | PRP | OPTIONS | TIMESFILE | STRING | name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. | | PRT | PRP | OPTIONS | DEV_FORCETERNARY | KEYWORD | force use of the ternary tracking method regardless of cell type in DISV grids. | | PRT | PRP | DIMENSIONS | NRELEASEPTS | INTEGER | is the number of particle release points. | | PRT | PRP | PACKAGEDATA | IRPTNO | INTEGER | integer value that defines the PRP release point number associated with the specified PACKAGEDATA data on the line. IRPTNO must be greater than zero and less than or equal to NRELEASEPTS. The program will terminate with an error if information for a PRP release point number is specified more than once. | @@ -1772,7 +1772,7 @@ | SWF | NAM | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that all model package flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. | | SWF | NAM | OPTIONS | NEWTON | KEYWORD | keyword that activates the Newton-Raphson formulation for surface water flow between connected reaches and stress packages that support calculation of Newton-Raphson terms. | | SWF | NAM | OPTIONS | UNDER_RELAXATION | KEYWORD | keyword that indicates whether the surface water stage in a reach will be under-relaxed when water levels fall below the bottom of the model below any given cell. By default, Newton-Raphson UNDER\_RELAXATION is not applied. | -| SWF | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. | +| SWF | NAM | PACKAGES | FTYPE | STRING | is the file type, which must be one of the following character values shown in table~\ref{table:ftype-swf}. Ftype may be entered in any combination of uppercase and lowercase. | | SWF | NAM | PACKAGES | FNAME | STRING | is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. | | SWF | NAM | PACKAGES | PNAME | STRING | is the user-defined name for the package. PNAME is restricted to 16 characters. No spaces are allowed in PNAME. PNAME character values are read and stored by the program for stress packages only. These names may be useful for labeling purposes when multiple stress packages of the same type are located within a single SWF Model. If PNAME is specified for a stress package, then PNAME will be used in the flow budget table in the listing file; it will also be used for the text entry in the cell-by-cell budget file. PNAME is case insensitive and is stored in all upper case letters. | | SWF | OC | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. | diff --git a/doc/mf6io/mf6ivar/tex/gwe-est-desc.tex b/doc/mf6io/mf6ivar/tex/gwe-est-desc.tex index bf787adc828..d708c3c848b 100644 --- a/doc/mf6io/mf6ivar/tex/gwe-est-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwe-est-desc.tex @@ -19,7 +19,7 @@ \item \texttt{cps}---is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent). -\item \texttt{rhos}---is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. +\item \texttt{rhos}---is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. \end{description} \item \textbf{Block: PACKAGEDATA} @@ -27,7 +27,7 @@ \begin{description} \item \texttt{cpw}---is the mass-based heat capacity of the simulated fluid. For example, units of J/kg/C may be used (or equivalent). -\item \texttt{rhow}---is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kg/m3. +\item \texttt{rhow}---is a user-specified value of the density of water. Value will remain fixed for the entire simulation. For example, if working in SI units, values may be entered as kilograms per cubic meter. \item \texttt{latheatvap}---is the user-specified value for the latent heat of vaporization. For example, if working in SI units, values may be entered as kJ/kg. diff --git a/doc/mf6io/mf6ivar/tex/gwe-nam-desc.tex b/doc/mf6io/mf6ivar/tex/gwe-nam-desc.tex index c42592c0fa3..5ede0afb946 100644 --- a/doc/mf6io/mf6ivar/tex/gwe-nam-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwe-nam-desc.tex @@ -15,7 +15,7 @@ \item \textbf{Block: PACKAGES} \begin{description} -\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwe}. Ftype may be entered in any combination of uppercase and lowercase. \item \texttt{fname}---is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. diff --git a/doc/mf6io/mf6ivar/tex/gwf-nam-desc.tex b/doc/mf6io/mf6ivar/tex/gwf-nam-desc.tex index d6674afa195..5faf613167c 100644 --- a/doc/mf6io/mf6ivar/tex/gwf-nam-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwf-nam-desc.tex @@ -19,7 +19,7 @@ \item \textbf{Block: PACKAGES} \begin{description} -\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwf}. Ftype may be entered in any combination of uppercase and lowercase. \item \texttt{fname}---is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. diff --git a/doc/mf6io/mf6ivar/tex/gwt-nam-desc.tex b/doc/mf6io/mf6ivar/tex/gwt-nam-desc.tex index 57e9efa2937..6197238f457 100644 --- a/doc/mf6io/mf6ivar/tex/gwt-nam-desc.tex +++ b/doc/mf6io/mf6ivar/tex/gwt-nam-desc.tex @@ -15,7 +15,7 @@ \item \textbf{Block: PACKAGES} \begin{description} -\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype-gwt}. Ftype may be entered in any combination of uppercase and lowercase. \item \texttt{fname}---is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. diff --git a/doc/mf6io/mf6ivar/tex/prt-nam-desc.tex b/doc/mf6io/mf6ivar/tex/prt-nam-desc.tex index 6c7d8fd876e..316a1547db9 100644 --- a/doc/mf6io/mf6ivar/tex/prt-nam-desc.tex +++ b/doc/mf6io/mf6ivar/tex/prt-nam-desc.tex @@ -15,7 +15,7 @@ \item \textbf{Block: PACKAGES} \begin{description} -\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype-prt}. Ftype may be entered in any combination of uppercase and lowercase. \item \texttt{fname}---is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. diff --git a/doc/mf6io/mf6ivar/tex/prt-prp-desc.tex b/doc/mf6io/mf6ivar/tex/prt-prp-desc.tex index fc1da97edae..830577fbfaf 100644 --- a/doc/mf6io/mf6ivar/tex/prt-prp-desc.tex +++ b/doc/mf6io/mf6ivar/tex/prt-prp-desc.tex @@ -33,11 +33,11 @@ \item \texttt{RELEASE\_TIMES}---keyword indicating release times will follow -\item \texttt{times}---times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. Explicit release times and release settings configured in the period block are additive and can be mixed and matched. +\item \texttt{times}---times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. \item \texttt{RELEASE\_TIMESFILE}---keyword indicating release times file name will follow -\item \texttt{timesfile}---name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. Explicit release times and release settings configured in the period block are additive and can be mixed and matched. +\item \texttt{timesfile}---name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. \end{description} \item \textbf{Block: DIMENSIONS} diff --git a/doc/mf6io/mf6ivar/tex/swf-nam-desc.tex b/doc/mf6io/mf6ivar/tex/swf-nam-desc.tex index fdc7325d2d0..7670aaf06b2 100644 --- a/doc/mf6io/mf6ivar/tex/swf-nam-desc.tex +++ b/doc/mf6io/mf6ivar/tex/swf-nam-desc.tex @@ -19,7 +19,7 @@ \item \textbf{Block: PACKAGES} \begin{description} -\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype}. Ftype may be entered in any combination of uppercase and lowercase. +\item \texttt{ftype}---is the file type, which must be one of the following character values shown in table~\ref{table:ftype-swf}. Ftype may be entered in any combination of uppercase and lowercase. \item \texttt{fname}---is the name of the file containing the package input. The path to the file should be included if the file is not located in the folder where the program was run. diff --git a/doc/mf6io/prt/namefile.tex b/doc/mf6io/prt/namefile.tex index 776f622be31..020e2daec64 100644 --- a/doc/mf6io/prt/namefile.tex +++ b/doc/mf6io/prt/namefile.tex @@ -30,7 +30,7 @@ \subsubsection{Explanation of Variables} OC6 & Output Control Option \\ \hline \end{tabular*} -\label{table:ftype} +\label{table:ftype-prt} \end{center} \normalsize \end{table} diff --git a/doc/mf6io/swf/namefile.tex b/doc/mf6io/swf/namefile.tex index 6bae5913123..c11477da175 100644 --- a/doc/mf6io/swf/namefile.tex +++ b/doc/mf6io/swf/namefile.tex @@ -37,7 +37,7 @@ \subsubsection{Explanation of Variables} OBS6 & Observations Option \\ \hline \end{tabular*} -\label{table:ftype} +\label{table:ftype-swf} \end{center} \normalsize \end{table}