feat(apt): transport functional for SFR, LAK, MAW, and UZF (#342)

* fix(uzf): fix indexing error in UZF (#274) * Error introduced as part of recent UZF refactoring * Closes #273 * fix(memory): some variables not deallocated (#278) Implemented new check in develop mode so code bombs with error if memory manager variable not deallocated * refactor(budobj): new budget object for advanced packages (#279) * single code base for writing binary budget files for advanced packages * single code base for creating and writing budget tables to list file for advanced packages * implemented for MAW, UZF, LAK, SFR, and MVR * closes #277 * update mf6exes from 2.0 to 3.0 * will allow generalized transport calculations for advanced packages * refactor(advanced packages): read static data as part of df() (#281) * refactor(advanced packages): modify advanced packages to read all static data as part of df() * modify setup_budobj to include the connectivity so that it is available to other models * fix(budterm): initialize nlist to zero (#283) * initialize nlist to zero (#284) * feat(apt): transport functional for SFR, LAK, MAW, and UZF * UZT is running now and test needs to be added next
MODFLOW-USGS · Mar 11, 2020 · 081b544 · 081b544
1 parent e48b381
commit 081b544
Show file tree

Hide file tree

Showing 25 changed files with 2,216 additions and 2,914 deletions.
diff --git a/doc/Common/gwt-uzttobs.tex b/doc/Common/gwt-uzttobs.tex
@@ -0,0 +1 @@
+UZT & concentration & uztno or boundname & -- & UZF cell concentration. If boundname is specified, boundname must be unique for each UZF cell. \\
diff --git a/doc/mf6io/gwt/gwt.tex b/doc/mf6io/gwt/gwt.tex
@@ -87,6 +87,10 @@ \subsection{Lake Transport (LKT) Package}
 \subsection{Multi-Aquifer Well Transport (MWT) Package}
 \input{gwt/mwt}
 
+\newpage
+\subsection{Unsaturated Zone Transport (UZT) Package}
+\input{gwt/uzt}
+
 \newpage
 \subsection{Flow Model Interface (FMI) Package}
 \input{gwt/fmi}

diff --git a/doc/mf6io/gwt/mwt.tex b/doc/mf6io/gwt/mwt.tex
@@ -1,4 +1,4 @@
-Multi-Aquifer Well Transport (MWT) Package information is read from the file that is specified by ``MWT6'' as the file type.  There can be as many MWT Packages as necessary for a GWT model. Each MWT Package is designed to work with flows from a corresponding GWF MWT Package. \mf uses the package name to determine which MWT Package corresponds to the MWT Package.  Therefore, the package name of the MWT Package (as specified in the GWT name file) must match with the name of the corresponding MAW Package (as specified in the GWF name file).  The GWT MWT Package cannot be used without a corresponding GWF MAW Package.
+Multi-Aquifer Well Transport (MWT) Package information is read from the file that is specified by ``MWT6'' as the file type.  There can be as many MWT Packages as necessary for a GWT model. Each MWT Package is designed to work with flows from a corresponding GWF MAW Package. \mf uses the package name to determine which MAW Package corresponds to the MWT Package.  Therefore, the package name of the MWT Package (as specified in the GWT name file) must match with the name of the corresponding MAW Package (as specified in the GWF name file).  The GWT MWT Package cannot be used without a corresponding GWF MAW Package.
 
 The MWT Package does not have a dimensions block; instead, dimensions for the MWT Package are set using the dimensions from the corresponding MAW Package.  For example, the MAW Package requires specification of the number of wells (NMAWWELLS).  MWT sets the number of wells equal to NMAWWELLS.  Therefore, the PACKAGEDATA block below must have NMAWWELLS entries in it.
 

diff --git a/doc/mf6io/gwt/namefile.tex b/doc/mf6io/gwt/namefile.tex
@@ -36,6 +36,8 @@ \subsubsection{Explanation of Variables}
 SRC6 & Mass Source Loading Package & * \\ 
 SFT6 & Streamflow Transport Package & * (must be same name as corresponding GWF SFR Package) \\ 
 LKT6 & Lake Transport Package & * (must be same name as corresponding GWF LAK Package) \\ 
+MWT6 & Multi-Aquifer Well Transport Package & * (must be same name as corresponding GWF MAW Package) \\ 
+UZT6 & Unsaturated Zone Transport Package & * (must be same name as corresponding GWF UZF Package) \\ 
 OBS6 & Observations Option \\
 \hline 
 \end{tabular*}

diff --git a/doc/mf6io/gwt/uzt.tex b/doc/mf6io/gwt/uzt.tex
@@ -0,0 +1,55 @@
+Unsaturated Zone Transport (UZT) Package information is read from the file that is specified by ``UZT6'' as the file type.  There can be as many UZT Packages as necessary for a GWT model. Each UZT Package is designed to work with flows from a corresponding GWF UZF Package. \mf uses the package name to determine which UZF Package corresponds to the UZT Package.  Therefore, the package name of the UZT Package (as specified in the GWT name file) must match with the name of the corresponding UZF Package (as specified in the GWF name file).  The GWT UZT Package cannot be used without a corresponding GWF UZF Package.
+
+The UZT Package does not have a dimensions block; instead, dimensions for the UZT Package are set using the dimensions from the corresponding UZF Package.  For example, the UZF Package requires specification of the number of wells (NUZFCELLS).  UZT sets the number of UZT cells equal to NUZFCELLS.  Therefore, the PACKAGEDATA block below must have NUZFCELLS entries in it.
+
+\vspace{5mm}
+\subsubsection{Structure of Blocks}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwt-uzt-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwt-uzt-packagedata.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwt-uzt-period.dat}
+
+\vspace{5mm}
+\subsubsection{Explanation of Variables}
+\begin{description}
+\input{./mf6ivar/tex/gwt-uzt-desc.tex}
+\end{description}
+
+\vspace{5mm}
+\subsubsection{Example Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwt-uzt-example.dat}
+
+\vspace{5mm}
+\subsubsection{Available observation types}
+Unsaturated Zone Transport Package observations include UZF cell concentration and all of the terms that contribute to the continuity equation for each UZF cell. Additional UZT Package observations include mass flow rates for individual UZF cells, or groups of UZF cells. The data required for each UZT Package observation type is defined in table~\ref{table:gwt-uztobstype}. Negative and positive values for \texttt{uzt} observations represent a loss from and gain to the GWT model, respectively. For all other flow terms, negative and positive values represent a loss from and gain from the UZT package, respectively.
+
+\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+\caption{Available UZT Package observation types} \tabularnewline
+
+\hline
+\hline
+\textbf{Stress Package} & \textbf{Observation type} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endfirsthead
+
+\captionsetup{textformat=simple}
+\caption*{\textbf{Table \arabic{table}.}{\quad}Available UZT Package observation types.---Continued} \tabularnewline
+
+\hline
+\hline
+\textbf{Stress Package} & \textbf{Observation type} & \textbf{ID} & \textbf{ID2} & \textbf{Description} \\
+\hline
+\endhead
+
+
+\hline
+\endfoot
+
+\input{../Common/gwt-uzttobs.tex}
+\label{table:gwt-uztobstype}
+\end{longtable}
+
+\vspace{5mm}
+\subsubsection{Example Observation Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwt-uzt-example-obs.dat}
+
+
diff --git a/doc/mf6io/mf6ivar/dfn/gwt-mwt.dfn b/doc/mf6io/mf6ivar/dfn/gwt-mwt.dfn
@@ -244,7 +244,7 @@ tagged false
 reader urword
 optional false
 longname obs6 input filename
-description REPLACE obs6_filename {'{#1}': 'LKT'}
+description REPLACE obs6_filename {'{#1}': 'MWT'}
 
 
 # --------------------- gwt mwt packagedata ---------------------
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		UZT & concentration & uztno or boundname & -- & UZF cell concentration. If boundname is specified, boundname must be unique for each UZF cell. \\