From 4161555e5ccda815ea2565b168e38a496bd44079 Mon Sep 17 00:00:00 2001 From: Eric Morway Date: Fri, 13 Dec 2024 08:05:37 -0800 Subject: [PATCH] fix(mf6io): cleanup typos in the gwe section of mf6io (#2100) * fix(mf6io): cleanup of typos in the gwe section of mf6io * weird that this popped up as a problem --- doc/Common/gwe-eslobs.tex | 2 +- doc/Common/gwe-obs.tex | 2 +- doc/mf6io/gwe/ctp.tex | 2 +- doc/mf6io/gwe/esl.tex | 2 +- doc/mf6io/gwe/fmi.tex | 2 +- doc/mf6io/gwe/gwe.tex | 18 ++++++++---------- doc/mf6io/gwe/uze.tex | 4 ++-- doc/mf6io/gwf/bcoptions.tex | 2 ++ doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn | 4 ++-- doc/mf6io/mf6ivar/dfn/gwe-cnd.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwe-ctp.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwe-esl.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwe-est.dfn | 2 +- doc/mf6io/mf6ivar/dfn/gwe-lke.dfn | 8 ++++---- doc/mf6io/mf6ivar/dfn/gwe-mwe.dfn | 4 ++-- doc/mf6io/mf6ivar/dfn/gwe-sfe.dfn | 12 ++++++------ doc/mf6io/mf6ivar/dfn/gwe-uze.dfn | 4 ++-- doc/mf6io/mf6ivar/mf6ivar.py | 2 +- 18 files changed, 38 insertions(+), 38 deletions(-) diff --git a/doc/Common/gwe-eslobs.tex b/doc/Common/gwe-eslobs.tex index c25662d1dd8..044a1cd4ea9 100644 --- a/doc/Common/gwe-eslobs.tex +++ b/doc/Common/gwe-eslobs.tex @@ -1 +1 @@ -ESL & esl & cellid or boundname & -- & Energy source loading rate between the groundwater system and a energy source loading boundary or a group of boundaries. \ No newline at end of file +ESL & esl & cellid or boundname & -- & Energy source loading rate between the groundwater system and an energy source loading boundary or a group of boundaries. \ No newline at end of file diff --git a/doc/Common/gwe-obs.tex b/doc/Common/gwe-obs.tex index 4d3913438b0..2b0f4b288f9 100644 --- a/doc/Common/gwe-obs.tex +++ b/doc/Common/gwe-obs.tex @@ -1,2 +1,2 @@ GWE & temperature & cellid & -- & Temperature at a specified cell. \\ -GWE & flow-ja-face & cellid & cellid & Energy flow in dimensions of watts between two adjacent cells. The energy flow rate includes the contributions from both advection and conduction (including mechanical dispersion) if those packages are active \ No newline at end of file +GWE & flow-ja-face & cellid & cellid & Energy flow in dimensions of energy per time between two adjacent cells. The energy flow rate includes the contributions from both advection and conduction (including mechanical dispersion) if those packages are active \ No newline at end of file diff --git a/doc/mf6io/gwe/ctp.tex b/doc/mf6io/gwe/ctp.tex index 0953d2e3367..4e98d4014b6 100644 --- a/doc/mf6io/gwe/ctp.tex +++ b/doc/mf6io/gwe/ctp.tex @@ -10,7 +10,7 @@ \subsubsection{Structure of Blocks} \vspace{5mm} \noindent \textit{FOR ANY STRESS PERIOD} \lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-ctp-period.dat} -\packageperioddescription +\gwepackageperioddescription \vspace{5mm} \subsubsection{Explanation of Variables} diff --git a/doc/mf6io/gwe/esl.tex b/doc/mf6io/gwe/esl.tex index b73fe6792f4..4f1c44122f4 100644 --- a/doc/mf6io/gwe/esl.tex +++ b/doc/mf6io/gwe/esl.tex @@ -10,7 +10,7 @@ \subsubsection{Structure of Blocks} \vspace{5mm} \noindent \textit{FOR ANY STRESS PERIOD} \lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-esl-period.dat} -\packageperioddescription +\gwepackageperioddescription \vspace{5mm} \subsubsection{Explanation of Variables} diff --git a/doc/mf6io/gwe/fmi.tex b/doc/mf6io/gwe/fmi.tex index 4113cb8283f..0c0a972c7d6 100644 --- a/doc/mf6io/gwe/fmi.tex +++ b/doc/mf6io/gwe/fmi.tex @@ -6,7 +6,7 @@ \item Flows are provided by a corresponding GWF Model running in the same simulation---in this case, all groundwater flows are calculated by the corresponding GWF Model and provided through FMI to the energy transport model. This is a common use case in which the user wants to run the flow and energy transport models as part of a single simulation. The GWF and GWE models must be part of a GWF-GWE Exchange that is listed in mfsim.nam. If a GWF-GWE Exchange is specified by the user, then the user does not need to specify an FMI Package input file for the simulation, unless an FMI option is needed. If a GWF-GWE Exchange is specified and the FMI Package is specified, then the PACKAGEDATA block below is not read or used. -\item There is no groundwater flow and the user is interested only in the effects of diffusion, sorption, and decay or production---in this case, FMI should not be provided in the GWE name file and the GWE model should not be listed in any GWF-GWE Exchanges in mfsim.nam. In this case, all groundwater flows are assumed to be zero and cells are assumed to be fully saturated. The SSM Package should not be activated in this case, because there can be no sources or sinks of water. Likewise, none of the advanced transport packages (LKE, SFE, MWE, and UZE) should be specified in the GWE name file. This type of model simulation without an FMI Package is included as an option to represent diffusion, sorption, and decay or growth in the absence of any groundwater flow. +\item There is no groundwater flow and the user is interested only in the effects of conduction and thermal decay or production---in this case, FMI should not be provided in the GWE name file and the GWE model should not be listed in any GWF-GWE Exchanges in mfsim.nam. In this case, all groundwater flows are assumed to be zero and cells are assumed to be fully saturated. The SSM Package should not be activated in this case, because there can be no sources or sinks of water. Likewise, none of the advanced transport packages (LKE, SFE, MWE, and UZE) should be specified in the GWE name file. This type of model simulation without an FMI Package is included as an option to represent conduction and thermal decay or production in the absence of any groundwater flow. \item Flows are provided from a previous GWF model simulation---in this case the FMI Package should be listed in the GWE name file and the head and budget files should be listed in the FMI PACKAGEDATA block. In this case, FMI reads the simulated head and flows from these files and makes them available to the energy transport model. There are some additional considerations when the heads and flows are provided from binary files. diff --git a/doc/mf6io/gwe/gwe.tex b/doc/mf6io/gwe/gwe.tex index 3f092e9e3a2..b314eef36fc 100644 --- a/doc/mf6io/gwe/gwe.tex +++ b/doc/mf6io/gwe/gwe.tex @@ -1,8 +1,8 @@ -Like GWT \citep{modflow6gwt}, the GWE Model simulates three-dimensional transport in flowing groundwater. The primary difference between GWT and GWE is that heat (i.e., temperature), instead of concentration, is the simulated ``species.'' As such, the GWE Model solves the heat transport equation using numerical methods and a generalized control-volume finite-difference approach, which can be used with regular MODFLOW grids (DIS Package) or with unstructured grids (DISV and DISU Packages). The GWE Model is designed to work with most of the new capabilities released with the GWF Model, including the Newton flow formulation, XT3D \citep{modflow6xt3d}, unstructured grids, advanced packages, the movement of water between packages. The GWF and GWE (and, if active, GWT) models operate simultaneously during a \mf simulation to represent coupled groundwater flow and heat transport. The GWE Model can also run separately from a GWF Model by reading the heads and flows saved by a previously run GWF Model. The GWE model is also capable of working with the flows from another groundwater flow model as long as the cell-by-cell and boundary flows and groundwater heads are written to ``linker'' files in the correct format. +Like GWT \citep{modflow6gwt}, the GWE Model simulates three-dimensional transport in flowing groundwater. The primary difference between GWT and GWE is that heat (i.e., temperature), instead of concentration, is the simulated ``species.'' As such, the GWE Model solves the heat transport equation using numerical methods and a generalized control-volume finite-difference approach, which can be used with regular MODFLOW grids (DIS Package) or with unstructured grids (DISV and DISU Packages). The GWE Model is designed to work with most of the new capabilities released with the GWF Model, including the Newton flow formulation, XT3D \citep{modflow6xt3d}, unstructured grids, advanced packages, and the movement of water between packages. The GWF and GWE (and, if active, GWT) models operate simultaneously during a \mf simulation to represent coupled groundwater flow and heat transport. The GWE Model can also run separately from a GWF Model by reading the heads and flows saved by a previously run GWF Model. The GWE model is also capable of working with the flows from another groundwater flow model as long as the cell-by-cell and boundary flows and groundwater heads are written to ``linker'' files in the correct format. -The purpose of the GWE Model is to calculate changes in groundwater temperature in both space and time. Groundwater temperature within an aquifer can change in response to different energy transport processes. These processes include (1) convective (advective) transport of heat with flowing groundwater, (2) the combined hydrodynamic dispersion processes of velocity-dependent mechanical dispersion and conduction (analogous to chemical diffusion), (3) thermal equilibrium with the aquifer matrix, (4) mixing with fluids from groundwater sources and sinks, and (5) direct addition of thermal energy. +The purpose of the GWE Model is to calculate changes in groundwater temperature in both space and time. Groundwater temperature within an aquifer can change in response to different energy transport processes. These processes include (1) convective (advective) transport of heat with flowing groundwater, (2) the combined hydrodynamic dispersion processes of velocity-dependent mechanical dispersion and conduction (analogous to chemical diffusion), (3) thermal equilibrium with the aquifer matrix, (4) mixing of fluids from groundwater sources and sinks, and (5) direct addition of thermal energy. -For GWE, the energy present in the aquifer is assumed to instantaneously equilibrate between the aqueous and solid phase domains. For example, a pulse of heat convecting through an aquifer will be retarded through thermal equilibration with the aquifer material. Conversely, the introduction of cold groundwater into a previously warm region of the aquifer will warm up, at least in part, as energy within the aquifer matrix transfers to the aqueous phase. Unlike GWT, the GWE Model type does not support an immobile domain. The energy that is transferred between the aqeous and solid phases of the groundwater system are tracked in the GWE Model budget. +For GWE, the temperature at any point in the aquifer is assumed to instantaneously equilibrate between the aqueous and solid phase domains. For example, a pulse of heat convecting through an aquifer will be retarded through thermal equilibration with the aquifer material. Conversely, the introduction of cold groundwater into a previously warm region of the aquifer will warm up, at least in part, as energy within the aquifer matrix transfers to the aqueous phase. Unlike GWT, the GWE Model type does not support an immobile domain. The energy that is transferred between the aqeous and solid phases of the groundwater system are tracked in the GWE Model budget. This section describes the data files for a \mf Groundwater Energy Transport (GWE) Model. A GWE Model is added to the simulation by including a GWE entry in the MODELS block of the simulation name file. There are three types of spatial discretization approaches that can be used with the GWE Model: DIS, DISV, and DISU. The input instructions for these three packages are not described here in this section on GWE Model input; input instructions for these three packages are described in the section on GWF Model input. @@ -19,9 +19,9 @@ \subsection{Information for Existing Heat Transport Modelers} \begin{enumerate} -\item The GWE Model uses parameters that are native to heat transport, including thermal conductivity of water, heat capacity of water, thermal conductivity of the aquifer material, heat capacity of of the aquifer material, and latent heat of vaporization. Therefore, users do not need to pre-calculate ``parameter equivalents'' when generating GWE model input; users can instead enter native parameter values that are readily available. +\item The GWE Model uses parameters that are native to heat transport, including thermal conductivity of water, heat capacity of water, thermal conductivity of the aquifer material, heat capacity of of the aquifer material, and latent heat of vaporization. Therefore, users do not need to pre-calculate solute-transport ``parameter equivalents'' when generating GWE model input; users can instead enter native parameter values that are readily available. -\item Thermal energy transport budgets written to the \mf list file are reported in units of energy (e.g., joules). Previously, using a program like MT3D-USGS \citep{mt3dusgs} to simulate heat transport, units in the list file budget did not correspond to thermal energy, but were reported in units of $\frac{m^{3 \;\circ}C}{d}$. To convert to thermal energy units, values in the list file had to be post-processed by multiplying each line item by the density of water ($\rho_w$) and the heat capacity of water ($C_p$) \citep{langevin2008seawat}. +\item Thermal energy transport budgets written to the \mf list file are reported in units of energy (e.g., joules). Previously, using a program like MT3D-USGS \citep{mt3dusgs} to emulate heat transport using solute transport, units in the list file budget did not correspond to thermal energy, but were reported in units of $\frac{m^{3 \;\circ}C}{d}$. To convert to thermal energy units, values in the list file had to be post-processed by multiplying each line item by the density of water ($\rho_w$) and the heat capacity of water ($C_p$) \citep{langevin2008seawat}. \item Thermal equilibrium between the aqueous and solid phases is assumed. Thus, simulated temperatures are representative of both phases. As a result, thermal conduction between adjacent cells may still occur even in the absence of convection. @@ -43,11 +43,11 @@ \subsection{Information for Existing Heat Transport Modelers} \item GWE and GWT use the same advection package source code. As a result, advection can be simulated using central-in-space weighting, upstream weighting, or an implicit second-order TVD scheme. Currently, neither the GWE or GWT models can use a Method of Characteristics (particle-based approaches) or an explicit TVD scheme to simulate convective (or advective) transport. Consequently, the GWE Model may require a higher level of spatial discretization than other transport models that use higher order terms for advection dominated systems. This can be an important limitation in problems involving sharp heat fronts. -\item The Viscosity Package may reference a GWE model directly for adjusting the viscosity-affected groundwater flow. +\item The Viscosity Package can use temperatures from the GWE model to adjust the viscosities in the flow model. \item GWE and GWT use the same Source and Sink Mixing (SSM) Package for representing the effects of GWF stress package inflows and outflows on simulated temperatures and concentrations. In a GWE simulation, there are two ways in which users can assign concentrations to the individual features in these stress package. The first way is to activate a temperature auxiliary variable in the corresponding GWF stress package. In the SSM input file, the user provides the name of the auxiliary variable to be used for temperature. The second way is to create a special SPC file, which contains user-assigned time-varying temperatures for stress package features. -\item The GWE model includes an EST Package, but does not include an IST Package. Heat transport-related parameters such as thermal conductivities and heat capacities are specified in the EST Package. +\item The GWE model includes an Energy Storage and Transfer (EST) Package that is analogous to the MST Package in the GWT Model. The GWE Model does not simulate immobile domains and therefore does not include an analog of the IST Package in the GWT Model. \item A GWE-GWE Exchange (introduced in version 6.5.0) can be used to tightly couple multiple heat transport models, as might be done in a nested grid configuration. @@ -55,12 +55,10 @@ \subsection{Information for Existing Heat Transport Modelers} \item As is the case with GWT, the GWE Model has not yet been programmed to work with the Skeletal Storage, Compaction, and Subsidence (CSUB) Package for the GWF Model. -\item There are many other differences between the \mf GWE Model and other solute transport models that work with MODFLOW, especially with regards to program design and input and output. Descriptions for the GWE input and output are described here. - \end{enumerate} \subsection{Units of Length and Time} -The GWF Model formulates the groundwater flow equation without using prescribed length and time units. Any consistent units of length and time can be used when specifying the input data for a simulation. This capability gives a certain amount of freedom to the user, but care must be exercised to avoid mixing units. The program cannot detect the use of inconsistent units. +The GWE Model formulates the groundwater energy transport equation without using prescribed length and time units. Any consistent units of length and time can be used when specifying the input data for a simulation. This capability gives a certain amount of freedom to the user, but care must be exercised to avoid mixing units. The program cannot detect the use of inconsistent units. \subsection{Thermal Energy Budget} A summary of all inflow (sources) and outflow (sinks) of thermal energy is referred to as an energy budget. \mf calculates an energy budget for the overall model as a check on the acceptability of the solution, and to provide a summary of the sources and sinks of energy to the flow system. The energy budget is printed to the GWE Model Listing File for specified time steps. diff --git a/doc/mf6io/gwe/uze.tex b/doc/mf6io/gwe/uze.tex index 5343658c683..bcad153cc59 100644 --- a/doc/mf6io/gwe/uze.tex +++ b/doc/mf6io/gwe/uze.tex @@ -1,6 +1,6 @@ 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. Furthermore, UZE requires the area of each UZE object to equal to the area of the grid cell hosting the corresponding UZF object. If the area of a UZF object is different than the host grid cell, the GWE model will exit with an error message indicating which cell is in violation of this condition. This check is unique to UZE, UZT does not require the area of the corresponding UZF object to equal the area of the host grid cell. If this error condition occurs, users should check whether the AUXMULTNAME option in the OPTIONS block of the corresponding UZF input file is activated. Finally, users should not create two (or more) UZF objects in the same cell using multiple UZF input packages. +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. Furthermore, UZE requires the area of each UZE object to equal to the area of the grid cell hosting the corresponding UZF object. If the area of a UZF object is different than the host grid cell, the GWE model will exit with an error message indicating which cell is in violation of this condition. This check is unique to UZE as UZT does not require the area of the corresponding UZF object to equal the area of the host grid cell. If this error condition occurs, users should check whether the AUXMULTNAME option in the OPTIONS block of the corresponding UZF input file is activated. Users could inadvertently circumvent the error check by creating two (or more) UZF objects in the same cell using multiple UZF input packages that each specify a UZF object for the same cell. \vspace{5mm} \subsubsection{Structure of Blocks} @@ -20,7 +20,7 @@ \subsubsection{Example Input File} \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. +Unsaturated Zone Energy Transport Package observations include UZF cell temperature and all of the terms that contribute to the continuity equation for each UZE cell. Additional UZE Package observations include energy flow rates for individual UZE cells, or groups of UZE 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 diff --git a/doc/mf6io/gwf/bcoptions.tex b/doc/mf6io/gwf/bcoptions.tex index 62e0efbf729..2a1794b23c2 100644 --- a/doc/mf6io/gwf/bcoptions.tex +++ b/doc/mf6io/gwf/bcoptions.tex @@ -40,6 +40,8 @@ \newcommand{\packageperioddescription}{All of the stress package information in the PERIOD block will continue to apply for subsequent stress periods until the end of the simulation, or until another PERIOD block is encountered. When a new PERIOD block is encountered, all of the stresses from the previous block are replaced with the stresses in the new PERIOD block. Note that this behavior is different from the advanced packages (MAW, SFR, LAK, and UZF). To turn off all of the stresses for a stress period, a PERIOD block must be specified with no entries. If a PERIOD block is not specified for the first stress period, then no stresses will be applied until the \texttt{iper} value of the first PERIOD block in the file.} +\newcommand{\gwepackageperioddescription}{All of the stress package information in the PERIOD block will continue to apply for subsequent stress periods until the end of the simulation, or until another PERIOD block is encountered. When a new PERIOD block is encountered, all of the stresses from the previous block are replaced with the stresses in the new PERIOD block. Note that this behavior is different from the advanced packages (MWE, SFE, LKE, and UZE). To turn off all of the stresses for a stress period, a PERIOD block must be specified with no entries. If a PERIOD block is not specified for the first stress period, then no stresses will be applied until the \texttt{iper} value of the first PERIOD block in the file.} + \newcommand{\packageperioddescriptionarray}[1]{All of the stress package information in the PERIOD block will continue to apply for subsequent stress periods until the end of the simulation, or until another PERIOD block is encountered. When a new PERIOD block is encountered, the array-based input specified by the user will replace the arrays currently in memory. If an array is not specified in the period block, then that array will retain its present values in memory. With the array-based input, the user must specify a {#1} rate of zero in order to turn {#1} off for a stress period. This behavior is different from list-based input in which an empty PERIOD block results in no stresses being applied.} \newcommand{\advancedpackageperioddescription}[2]{All of the advanced stress package information in the PERIOD block will continue to apply for subsequent stress periods until the end of the simulation, or until another PERIOD block is encountered. When a new PERIOD block is encountered only the {#2} specified in the new period block will be changed. A {#1} not specified in the new period block will continue to behave according to its specification in the previous PERIOD block. Note that this behavior is different from the simple stress packages (CHD, WEL, DRN, RIV, GHB, RCH and EVT), in which any stress not specified in a new PERIOD block will be removed. To turn off all of the advanced stresses for a stress period, a PERIOD block must be specified with settings that deactivate the {#2}. If a PERIOD block is not specified for the first stress period, then no stresses will be applied.} diff --git a/doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn b/doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn index 7b79ce7e7ea..1f4f03e6f8e 100644 --- a/doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn +++ b/doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn @@ -24,7 +24,7 @@ shape (naux) reader urword optional true longname keyword to specify aux variables -description an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWF-GWF Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name ``ANGLDEGX'' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on ``ANGLDEGX'' is provided in the description of the DISU Package. If an auxiliary variable with the name ``CDIST'' is found, then this information will be used as the straight-line connection distance, including the vertical component, between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models. +description an array of auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided. Most auxiliary variables will not be used by the GWE-GWE Exchange, but they will be available for use by other parts of the program. If an auxiliary variable with the name ``ANGLDEGX'' is found, then this information will be used as the angle (provided in degrees) between the connection face normal and the x axis, where a value of zero indicates that a normal vector points directly along the positive x axis. The connection face normal is a normal vector on the cell face shared between the cell in model 1 and the cell in model 2 pointing away from the model 1 cell. Additional information on ``ANGLDEGX'' is provided in the description of the DISU Package. If an auxiliary variable with the name ``CDIST'' is found, then this information will be used as the straight-line connection distance, including the vertical component, between the two cell centers. Both ANGLDEGX and CDIST are required if specific discharge is calculated for either of the groundwater models. block options name boundnames @@ -162,7 +162,7 @@ tagged false reader urword optional false longname obs6 input filename -description is the file name of the observations input file for this exchange. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE package. +description is the file name of the observations input file for this exchange. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package. block options name dev_interfacemodel_on diff --git a/doc/mf6io/mf6ivar/dfn/gwe-cnd.dfn b/doc/mf6io/mf6ivar/dfn/gwe-cnd.dfn index 4d9ef1b70a1..0ff0a314dbd 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-cnd.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-cnd.dfn @@ -114,5 +114,5 @@ layered true netcdf true optional true longname thermal conductivity of the aquifer material -description thermal conductivity of the aquifer material +description thermal conductivity of the solid aquifer material diff --git a/doc/mf6io/mf6ivar/dfn/gwe-ctp.dfn b/doc/mf6io/mf6ivar/dfn/gwe-ctp.dfn index d8dd2bc68bf..431a0a8f732 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-ctp.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-ctp.dfn @@ -139,7 +139,7 @@ type integer reader urword optional false longname maximum number of constant temperatures -description REPLACE maxbound {'{#1}': 'constant temperatures'} +description REPLACE maxbound {'{#1}': 'constant temperature'} # --------------------- gwe ctp period --------------------- diff --git a/doc/mf6io/mf6ivar/dfn/gwe-esl.dfn b/doc/mf6io/mf6ivar/dfn/gwe-esl.dfn index 534db1b0278..ce6e94cfed3 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-esl.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-esl.dfn @@ -134,7 +134,7 @@ type integer reader urword optional false longname maximum number of sources -description REPLACE maxbound {'{#1}': 'sources'} +description REPLACE maxbound {'{#1}': 'source'} # --------------------- gwe esl period --------------------- diff --git a/doc/mf6io/mf6ivar/dfn/gwe-est.dfn b/doc/mf6io/mf6ivar/dfn/gwe-est.dfn index 311d1e76bcc..283900bd6b2 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-est.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-est.dfn @@ -14,7 +14,7 @@ type keyword reader urword optional true longname activate zero-order decay -description is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY\_SORBED (if sorption is active) are specified in the GRIDDATA block. +description is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY is specified in the GRIDDATA block. block options name density_water diff --git a/doc/mf6io/mf6ivar/dfn/gwe-lke.dfn b/doc/mf6io/mf6ivar/dfn/gwe-lke.dfn index b59b50420b2..294250cfe26 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-lke.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-lke.dfn @@ -382,7 +382,7 @@ tagged true in_record true reader urword longname lake temperature status -description keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no solute mass fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value. +description keyword option to define lake status. STATUS can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is ACTIVE, which means that temperature will be calculated for the lake. If a lake is inactive, then there will be no energy fluxes into or out of the lake and the inactive value will be written for the lake temperature. If a lake is constant, then the temperature for the lake will be fixed at the user specified value. block period name temperature @@ -415,7 +415,7 @@ in_record true reader urword time_series true longname evaporation temperature -description real or character value that defines the temperature of evaporated water $(^{\circ}C)$ for the reach. If this temperature value is larger than the simulated temperature in the reach, then the evaporated water will be removed at the same temperature as the reach. 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. +description real or character value that defines the temperature of evaporated water $(e.g., ^{\circ}C or ^{\circ}F)$ for the reach. If this temperature value is larger than the simulated temperature in the reach, then the evaporated water will be removed at the same temperature as the reach. 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 @@ -427,7 +427,7 @@ in_record true reader urword time_series true longname runoff temperature -description real or character value that defines the temperature of runoff 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. +description real or character value that defines the temperature of runoff for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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 ext-inflow @@ -438,7 +438,7 @@ in_record true reader urword time_series true longname ext-inflow temperature -description real or character value that defines the temperature of external inflow 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. +description real or character value that defines the temperature of external inflow for the lake. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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 auxiliaryrecord diff --git a/doc/mf6io/mf6ivar/dfn/gwe-mwe.dfn b/doc/mf6io/mf6ivar/dfn/gwe-mwe.dfn index c805b6533fe..9b69409c30c 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-mwe.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-mwe.dfn @@ -294,7 +294,7 @@ tagged false in_record true reader urword longname thermal conductivity of the feature -description is the thermal conductivity of the of the interface between the aquifer cell and the feature. +description is the thermal conductivity of the interface between the aquifer cell and the feature. block packagedata name fthk @@ -404,7 +404,7 @@ in_record true reader urword time_series true longname well injection temperature -description real or character value that defines the injection solute temperature $^{\circ}C$ for the well. 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. +description real or character value that defines the injection temperature $(e.g., ^{\circ}C or ^{\circ}F)$ for the well. 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 auxiliaryrecord diff --git a/doc/mf6io/mf6ivar/dfn/gwe-sfe.dfn b/doc/mf6io/mf6ivar/dfn/gwe-sfe.dfn index 610e3911ff1..de720c285b0 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-sfe.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-sfe.dfn @@ -26,7 +26,7 @@ shape reader urword optional true longname keyword to specify name of temperature auxiliary variable in flow package -description keyword to specify the name of an auxiliary variable provided in the corresponding flow package (i.e., FLOW\_PACKAE\_NAME). If specified, then the simulated temperatures from this advanced energy transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced energy transport package are read from a file, then this option will have no effect. +description keyword to specify the name of an auxiliary variable provided in the corresponding flow package (i.e., FLOW\_PACKAGE\_NAME). If specified, then the simulated temperatures from this advanced energy transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced energy transport package are read from a file, then this option will have no effect. block options name boundnames @@ -252,7 +252,7 @@ tagged false reader urword optional false longname obs6 input filename -description REPLACE obs6_filename {'{#1}': 'SFT'} +description REPLACE obs6_filename {'{#1}': 'SFE'} # --------------------- gwe sfe packagedata --------------------- @@ -404,7 +404,7 @@ in_record true reader urword time_series true longname rainfall temperature -description real or character value that defines the rainfall temperature $(^{\circ}C)$ for the reach. 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. +description real or character value that defines the rainfall temperature $(e.g., ^{\circ}C or ^{\circ}F)$ for the reach. 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 evaporation @@ -415,7 +415,7 @@ in_record true reader urword time_series true longname evaporation temperature -description real or character value that defines the temperature of evaporated water $(^{\circ}C)$ for the reach. If this temperature value is larger than the simulated temperature in the reach, then the evaporated water will be removed at the same temperature as the reach. 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. +description real or character value that defines the temperature of evaporated water $(e.g., ^{\circ}C or ^{\circ}F)$ for the reach. If this temperature value is larger than the simulated temperature in the reach, then the evaporated water will be removed at the same temperature as the reach. 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 runoff @@ -426,7 +426,7 @@ in_record true reader urword time_series true longname runoff temperature -description real or character value that defines the temperature of runoff $(^{\circ}C)$ for the reach. 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. +description real or character value that defines the temperature of runoff $(e.g., ^{\circ}C or ^{\circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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 @@ -437,7 +437,7 @@ in_record true reader urword time_series true longname inflow temperature -description real or character value that defines the temperature of inflow $(^{\circ}C)$ for the reach. 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. +description real or character value that defines the temperature of inflow $(e.g., ^{\circ}C or ^{\circ}F)$ for the reach. Users are free to use whatever temperature scale they want, which might include negative temperatures. 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 auxiliaryrecord diff --git a/doc/mf6io/mf6ivar/dfn/gwe-uze.dfn b/doc/mf6io/mf6ivar/dfn/gwe-uze.dfn index 1f272617b73..2599e0f8f94 100644 --- a/doc/mf6io/mf6ivar/dfn/gwe-uze.dfn +++ b/doc/mf6io/mf6ivar/dfn/gwe-uze.dfn @@ -26,7 +26,7 @@ shape reader urword optional true longname keyword to specify name of concentration auxiliary variable in flow package -description keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated concentrations from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect. +description keyword to specify the name of an auxiliary variable in the corresponding flow package. If specified, then the simulated temperatures from this advanced transport package will be copied into the auxiliary variable specified with this name. Note that the flow package must have an auxiliary variable with this name or the program will terminate with an error. If the flows for this advanced transport package are read from a file, then this option will have no effect. block options name boundnames @@ -384,7 +384,7 @@ in_record true reader urword time_series true longname infiltration temperature -description real or character value that defines the temperature of the infiltration $(^\circ C)$ for the UZF cell. 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. +description real or character value that defines the temperature of the infiltration $(e.g., ^{\circ}C or ^{\circ}F)$ for the UZF cell. 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 uzet diff --git a/doc/mf6io/mf6ivar/mf6ivar.py b/doc/mf6io/mf6ivar/mf6ivar.py index 4bbace57b09..9e13b70bcbf 100644 --- a/doc/mf6io/mf6ivar/mf6ivar.py +++ b/doc/mf6io/mf6ivar/mf6ivar.py @@ -196,7 +196,7 @@ def parse_mf6var_file(fname): RTD_DOC_DIR_PATH = Path(__file__).parents[3] / ".build_rtd_docs" / "_mf6io" COMMON_DFN_PATH = parse_mf6var_file(DFNS_DIR_PATH / "common.dfn") COMMON_DIR_PATH = MF6IVAR_DIR_PATH.parent.parent / "Common" -DEFAULT_MODELS = ["gwf", "gwt", "gwe", "prt"] # , "chf", "olf"] +DEFAULT_MODELS = ["gwf", "gwt", "gwe", "prt"] # , "chf", "olf"] VALID_TYPES = [ "integer", "double precision",