Adding unsaturated-zone energy transport (UZE) package. Includes 2 ne…

…w autotests
geohackweek · Feb 9, 2024 · 5be224f · 5be224f
1 parent 3a6b1ef
commit 5be224f
Show file tree

Hide file tree

Showing 22 changed files with 3,470 additions and 18 deletions.
diff --git a/autotest/test_gwe_uze00.py b/autotest/test_gwe_uze00.py
diff --git a/autotest/test_gwe_uze00_flux.py b/autotest/test_gwe_uze00_flux.py
diff --git a/doc/Common/gwe-uzeobs.tex b/doc/Common/gwe-uzeobs.tex
@@ -1,14 +1,14 @@
 % general APT observations
-UZE & temperature & ifno or boundname & -- & uze cell temperature. If boundname is specified, boundname must be unique for each uze cell. \\
-UZE & flow-ja-face & ifno or boundname & ifno or -- & Energy flow between two uze cells. If a boundname is specified for ID1, then the result is the total energy flow for all uze cells. If a boundname is specified for ID1 then ID2 is not used.\\
-UZE & storage & ifno or boundname & -- & Simulated energy storage flow rate for a uze cell or group of uze cells. \\
-UZE & constant & ifno or boundname & -- & Simulated energy constant-flow rate for a uze cell or a group of uze cells. \\
-UZE & from-mvr & ifno or boundname & -- & Simulated energy inflow into a uze cell or group of uze cells from the MVE package. Energy inflow is calculated as the product of provider temperature and the mover flow rate. \\
-UZE & uze & ifno or boundname & -- & Energy flow rate for a uze cell or group of uze cells and its aquifer connection(s). \\
+UZE & temperature & uzeno or boundname & -- & uze cell temperature. If boundname is specified, boundname must be unique for each uze cell. \\
+UZE & flow-ja-face & uzeno or boundname & uzeno or -- & Energy flow between two uze cells. If a boundname is specified for ID1, then the result is the total energy flow for all uze cells. If a boundname is specified for ID1 then ID2 is not used.\\
+UZE & storage & uzeno or boundname & -- & Simulated energy storage flow rate for a uze cell or group of uze cells. \\
+UZE & constant & uzeno or boundname & -- & Simulated energy constant-flow rate for a uze cell or a group of uze cells. \\
+UZE & from-mvr & uzeno or boundname & -- & Simulated energy inflow into a uze cell or group of uze cells from the MVE package. Energy inflow is calculated as the product of provider temperature and the mover flow rate. \\
+UZE & uze & uzeno or boundname & -- & Energy flow rate for a uze cell or group of uze cells and its aquifer connection(s). \\
 
 %observations specific to the uze package
 % infiltration rej-inf uzet rej-inf-to-mvr
-UZE & infiltration & ifno or boundname & -- & Infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. \\
-UZE & rej-inf & ifno or boundname & -- & Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. \\
-UZE & uzet & ifno or boundname & -- & Unsaturated zone evapotranspiration rate applied to a uze cell or group of uze cells multiplied by the latent heat of vaporization, heat capacity of the simulated fluid, and density of the simulated flued. \\
-UZE & rej-inf-to-mvr & ifno or boundname & -- & Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature that is sent to the mover package. \\
+UZE & infiltration & uzeno or boundname & -- & Infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. \\
+UZE & rej-inf & uzeno or boundname & -- & Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature. \\
+UZE & uzet & uzeno or boundname & -- & Unsaturated zone evapotranspiration rate applied to a uze cell or group of uze cells multiplied by the uze cell temperature. \\
+UZE & rej-inf-to-mvr & uzeno or boundname & -- & Rejected infiltration rate applied to a uze cell or group of uze cells multiplied by the infiltration temperature that is sent to the mover package. \\
diff --git a/doc/mf6io/gwe/gwe.tex b/doc/mf6io/gwe/gwe.tex
@@ -137,6 +137,10 @@ \subsection{Lake Energy Transport (LKE) Package}
 \subsection{Multi-Aquifer Well Energy Transport (MWE) Package}
 \input{gwe/mwe}
 
+\newpage
+\subsection{Unsaturated-Zone Energy Transport (UZE) Package}
+\input{gwe/uze}
+
 \newpage
 \subsection{Flow Model Interface (FMI) Package}
 \input{gwe/fmi}

diff --git a/doc/mf6io/gwe/namefile.tex b/doc/mf6io/gwe/namefile.tex
@@ -37,6 +37,7 @@ \subsubsection{Explanation of Variables}
 SFE6 & Streamflow Energy Transport Package & * \\
 LKE6 & Lake Energy Transport Package & * \\
 MWE6 & Multi-Aquifer Well Energy Transport Package & * \\
+UZE6 & Unsaturated-Zone Energy Transport Package & * \\
 OBS6 & Observations Option \\
 \hline 
 \end{tabular*}

diff --git a/doc/mf6io/gwe/uze.tex b/doc/mf6io/gwe/uze.tex
@@ -0,0 +1,55 @@
+Unsaturated Zone Energy Transport (UZE) Package information is read from the file that is specified by ``UZE6'' as the file type. There can be as many UZE Packages as necessary for a GWE model. Each UZE Package is designed to work with flows from a corresponding GWF UZF Package. By default \mf uses the UZE package name to determine which UZF Package corresponds to the UZE Package. Therefore, the package name of the UZE Package (as specified in the GWE name file) must match with the name of the corresponding UZF Package (as specified in the GWF name file). Alternatively, the name of the flow package can be specified using the FLOW\_PACKAGE\_NAME keyword in the options block. The GWE UZE Package cannot be used without a corresponding GWF UZF Package.
+
+The UZE Package does not have a dimensions block; instead, dimensions for the UZE Package are set using the dimensions from the corresponding UZF Package. For example, the UZF Package requires specification of the number of cells (NUZFCELLS). UZE sets the number of UZE 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/gwe-uze-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-uze-packagedata.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-uze-period.dat}
+
+\vspace{5mm}
+\subsubsection{Explanation of Variables}
+\begin{description}
+\input{./mf6ivar/tex/gwe-uze-desc.tex}
+\end{description}
+
+\vspace{5mm}
+\subsubsection{Example Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwe-uze-example.dat}
+
+\vspace{5mm}
+\subsubsection{Available observation types}
+Unsaturated Zone Energy Transport Package observations include UZF cell temperature and all of the terms that contribute to the continuity equation for each UZF cell. Additional UZE Package observations include energy flow rates for individual UZF cells, or groups of UZF cells. The data required for each UZE Package observation type is defined in table~\ref{table:gwe-uzeobstype}. Negative and positive values for \texttt{uzt} observations represent a loss from and gain to the GWE model, respectively. For all other flow terms, negative and positive values represent a loss from and gain from the UZE package, respectively.
+
+\begin{longtable}{p{2cm} p{2.75cm} p{2cm} p{1.25cm} p{7cm}}
+\caption{Available UZE 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 UZE 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/gwe-uzeobs.tex}
+\label{table:gwe-uzeobstype}
+\end{longtable}
+
+\vspace{5mm}
+\subsubsection{Example Observation Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwe-uze-example-obs.dat}
+
+