docs(release): updates for 6.5.0 release (#1836)

christianlangevin · web-flow · commit 977a7acd31a0 · 2024-05-20T19:18:25.000-05:00
diff --git a/doc/ReleaseNotes/ReleaseNotes.tex b/doc/ReleaseNotes/ReleaseNotes.tex
@@ -254,17 +254,25 @@ \section{Installation and Execution}
 
 % -------------------------------------------------
 \section{Compiling MODFLOW~6}
-MODFLOW~6 has been compiled using Intel Fortran and GNU Fortran on Windows, macOS, and several Linux operating systems. All MODFLOW~6 distributions are currently compiled with Intel Fortran. Because the program uses relatively new Fortran functionality, recent versions of the compilers may be required for successful compilation. MODFLOW~6 is not yet compatible with the latest versions of the Intel toolchain, however.
+MODFLOW~6 has been compiled using Intel Fortran and GNU Fortran on Windows, macOS, and several Linux operating systems. All MODFLOW~6 distributions are currently compiled with Intel Fortran. Because the program uses relatively new Fortran functionality, recent versions of the compilers may be required for successful compilation. MODFLOW~6 has been successfully compiled with the latest versions of the Intel toolchain.
 
-MODFLOW~6 is currently tested with gfortran 7-12 on Linux and gfortran 12 on macOS and Windows. The gfortran version can be queried with ``\verb|gfortran --version|''.  Intel Fortran Compiler Classic version 2022.3.0 is currently tested on all three platforms. Some 2021 versions have also been reported compatible. At this time, MODFLOW~6 is not compatible with the next-generation Intel Fortran Compiler `ifx`.
+MODFLOW~6 is currently tested with gfortran 11-13 on Linux, macOS, and Windows. The gfortran version can be queried with ``\verb|gfortran --version|''.  Intel Fortran Compiler Classic version 2022.3.0 is currently tested on all three platforms. Some 2021 versions have also been reported compatible. MODFLOW~6 is also compatible with the next-generation Intel Fortran Compiler `ifx`; however, additional testing is underway.
 
-Meson is the recommended build tool for MODFLOW~6.  For more detailed compilation instructions, please refer to \url{https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#building}.
+Instructions for compiling the parallel version of MODFLOW~6 are available through a dedicated page on the \href{https://github.com/MODFLOW-USGS/modflow6/wiki/Parallel-MODFLOW-User-Guide}{MODFLOW~6 repository}.
 
-This distribution contains the Microsoft Visual Studio solution and project files for compiling MODFLOW~6 on Windows using the Intel Fortran Compiler Classic.  The files have been used successfully with recent versions of Microsoft Visual Studio Community 2019 and the Intel Fortran Compiler Classic.
+There are several options for building MODFLOW, as described below.
 
-This distribution also includes a makefile for compiling MODFLOW~6 with \texttt{gfortran}.  The makefile is contained in the \texttt{make} folder.
+\begin{itemize}
+
+\item Meson is the recommended build tool for MODFLOW~6.  Refer to the \href{https://github.com/MODFLOW-USGS/modflow6/blob/develop/DEVELOPER.md#building}{detailed compilation instructions} for more information.
+
+\item The distribution includes Microsoft Visual Studio solution and project files for compiling MODFLOW~6 on Windows using the Intel Fortran Compiler Classic.  The files have been used successfully with recent versions of Microsoft Visual Studio Community 2019 and the Intel Fortran Compiler Classic.
 
-For those familiar with Python, the pymake package can also be used to compile MODFLOW~6.  Additional information on the Python pymake utility can be found at: \url{https://github.com/modflowpy/pymake}.
+\item This distribution also includes a makefile for compiling MODFLOW~6 with \texttt{gfortran}.  The makefile is contained in the \texttt{make} folder.
+
+\item For those familiar with Python, the \href{https://github.com/modflowpy/pymake}{pymake package} can also be used to compile MODFLOW~6.
+
+\end{itemize}
 
 % -------------------------------------------------
 \section{System Requirements}
diff --git a/doc/mf6io/body.tex b/doc/mf6io/body.tex
@@ -65,6 +65,11 @@
 \SECTION{Iterative Model Solution}
 \input{ims.tex}
 
+%Explicit Model Solution (IMS)
+\newpage
+\SECTION{Explicit Model Solution}
+\input{ems.tex}
+
 %OBS Utility Input Instructions
 \newpage
 \SECTION{Observation (OBS) Utility}
diff --git a/doc/mf6io/ems.tex b/doc/mf6io/ems.tex
@@ -0,0 +1 @@
+An explicit model solution (EMS) is specified within the SOLUTIONGROUP block in the simulation name file.  The explicit model solution requires the individual models that are added to it to solve themselves.  The explicit model solution presently works with the Particle Tracking (PRT) Model, which solves for particle trajectories.  The current input file for EMS has no options or input; however an empty input file is required if EMS is required for particle tracking.
diff --git a/doc/mf6io/mf6ivar/dfn/prt-prp.dfn b/doc/mf6io/mf6ivar/dfn/prt-prp.dfn
@@ -25,7 +25,6 @@ reader urword
 optional true
 longname exit solve method
 description the method for iterative solution of particle exit location and time in the generalized Pollock's method.  1 Brent, 2 Chandrupatla.  The default is Brent.
-default_value 1
 
 block options
 name exit_solve_tolerance
diff --git a/doc/mf6io/mf6ivar/dfn/sim-nam.dfn b/doc/mf6io/mf6ivar/dfn/sim-nam.dfn
@@ -220,7 +220,7 @@ in_record true
 tagged false
 reader urword
 longname type of solution
-description is the type of solution.  The Integrated Model Solution (IMS6) is the only supported option in this version.
+description is the type of solution.  The Integrated Model Solution (IMS6) and Explicit Model Solution (EMS6) are the only supported options in this version.
 
 block solutiongroup
 name slnfname
diff --git a/doc/mf6io/mf6ivar/md/mf6ivar.md b/doc/mf6io/mf6ivar/md/mf6ivar.md
@@ -20,7 +20,7 @@
 | SIM | NAM | EXCHANGES | EXGMNAMEB | STRING | is the name of the second model that is part of this exchange. |
 | SIM | NAM | SOLUTIONGROUP | GROUP_NUM | INTEGER | is the group number of the solution group.  Solution groups must be numbered sequentially, starting with group number one. |
 | SIM | NAM | SOLUTIONGROUP | MXITER | INTEGER | is the maximum number of outer iterations for this solution group.  The default value is 1.  If there is only one solution in the solution group, then MXITER must be 1. |
-| SIM | NAM | SOLUTIONGROUP | SLNTYPE | STRING | is the type of solution.  The Integrated Model Solution (IMS6) is the only supported option in this version. |
+| SIM | NAM | SOLUTIONGROUP | SLNTYPE | STRING | is the type of solution.  The Integrated Model Solution (IMS6) and Explicit Model Solution (EMS6) are the only supported options in this version. |
 | SIM | NAM | SOLUTIONGROUP | SLNFNAME | STRING | name of file containing solution input. |
 | SIM | NAM | SOLUTIONGROUP | SLNMNAMES | STRING (:) | is the array of model names to add to this solution.  The number of model names is determined by the number of model names the user provides on this line. |
 | SIM | TDIS | OPTIONS | TIME_UNITS | STRING | is the time units of the simulation.  This is a text string that is used as a label within model output files.  Values for time\_units may be ``unknown'',  ``seconds'', ``minutes'', ``hours'', ``days'', or ``years''.  The default time unit is ``unknown''. |
@@ -386,7 +386,7 @@
 | GWE | OC | OPTIONS | BUDGETCSV | KEYWORD | keyword to specify that record corresponds to the budget CSV. |
 | GWE | OC | OPTIONS | BUDGETCSVFILE | STRING | name of the comma-separated value (CSV) output file to write budget summary information.  A budget summary record will be written to this file for each time step of the simulation. |
 | GWE | OC | OPTIONS | TEMPERATURE | KEYWORD | keyword to specify that record corresponds to temperature. |
-| GWE | OC | OPTIONS | TEMPERATUREFILE | STRING | name of the output file to write conc information. |
+| GWE | OC | OPTIONS | TEMPERATUREFILE | STRING | name of the output file to write temperature information. |
 | GWE | OC | OPTIONS | PRINT_FORMAT | KEYWORD | keyword to specify format for printing to the listing file. |
 | GWE | OC | OPTIONS | COLUMNS | INTEGER | number of columns for writing data. |
 | GWE | OC | OPTIONS | WIDTH | INTEGER | width for writing each number. |
diff --git a/doc/mf6io/mf6ivar/tex/gwe-oc-desc.tex b/doc/mf6io/mf6ivar/tex/gwe-oc-desc.tex
@@ -15,7 +15,7 @@
 
 \item \texttt{TEMPERATURE}---keyword to specify that record corresponds to temperature.
 
-\item \texttt{temperaturefile}---name of the output file to write conc information.
+\item \texttt{temperaturefile}---name of the output file to write temperature information.
 
 \item \texttt{PRINT\_FORMAT}---keyword to specify format for printing to the listing file.
 
diff --git a/doc/mf6io/mf6ivar/tex/sim-nam-desc.tex b/doc/mf6io/mf6ivar/tex/sim-nam-desc.tex
@@ -55,7 +55,7 @@
 
 \item \texttt{mxiter}---is the maximum number of outer iterations for this solution group.  The default value is 1.  If there is only one solution in the solution group, then MXITER must be 1.
 
-\item \texttt{slntype}---is the type of solution.  The Integrated Model Solution (IMS6) is the only supported option in this version.
+\item \texttt{slntype}---is the type of solution.  The Integrated Model Solution (IMS6) and Explicit Model Solution (EMS6) are the only supported options in this version.
 
 \item \texttt{slnfname}---name of file containing solution input.
 
diff --git a/src/Model/SurfaceWaterFlow/swf.f90 b/src/Model/SurfaceWaterFlow/swf.f90
@@ -3,36 +3,14 @@
 !!
 !! This module contains the SWF Model
 !!
-!! Status and remaining tasks
-!!   ONGOING -- Implement SWF infrastructure
-!!   DONE -- Implement Explicit Model Solution (EMS6) to handle explicit models
-!!   DONE -- Implement DISV1D Package
-!!   DONE -- Implement FLW Package to handle lateral and point inflows
-!!   DONE -- Transfer results into the flowja vector
-!!   DONE -- Implement strategy for storing outflow terms and getting them into budget
-!!   DONE -- Implement SWF and FLW advance routines to handle transient problems
-!!   DONE -- Implement storage terms and getting them into budget
-!!   DONE -- Observations
-!!   DONE -- Initial conditions?
-!!   DONE -- Rework the Iterative Model Solution (IMS6) to handle both implicit and explicit models
-!!   DONE -- Implement output control
-!!   DONE -- Add outflow as a dependent variable that can be written and printed (qoutflow)
-!!   DONE -- Revaluate explicit model solution and consider implementing ExplicitModelType?
-!!   DONE -- Add test of the binary outflow
-!!   DONE -- Rename Stream Network Flow (SWF) to Surface Water Flow (SWF) Model
-!!   DONE -- Rename segment to reach
-!!   Look into mass conservative MC method (https://hess.copernicus.org/articles/11/1645/2007/hess-11-1645-2007.pdf)
+!! Remaining tasks
 !!   Implement IDOMAIN support
-!!   Use dag_module to calculate iseg_order (if iseg_order not specified by user)
-!!   We may need subcells and subtiming to improve accuracy
-!!   Add support for nonlinear Muskingum Cunge
-!!   Deal with the timestep and subtiming issues
 !!   Flopy support for DISV1D and DISV1D binary grid file
 !!   Flopy support for .output() method for SWF
 !!   Mover support?
 !!   SWF-SWF Exchange
 !!   SWF-SWF Exchange in parallel
-!!   Create QGW package for leakage into or out of groundwater
+!!   GHB-like package for aquifer exchange as a stress package
 !!
 !<
 module SwfModule

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+An explicit model solution (EMS) is specified within the SOLUTIONGROUP block in the simulation name file. The explicit model solution requires the individual models that are added to it to solve themselves. The explicit model solution presently works with the Particle Tracking (PRT) Model, which solves for particle trajectories. The current input file for EMS has no options or input; however an empty input file is required if EMS is required for particle tracking.`