Skip to content

Commit

Permalink
Rebrand gwe dispersion package acronym to CND (conduction) since that…
Browse files Browse the repository at this point in the history
… is the dominant process in heat transport
  • Loading branch information
emorway-usgs committed Jan 18, 2024
1 parent 5874959 commit fea5a04
Show file tree
Hide file tree
Showing 33 changed files with 373 additions and 373 deletions.
6 changes: 3 additions & 3 deletions autotest/test_gwe_dsp.py → autotest/test_gwe_cnd.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
# Base simulation and model name and workspace

viscosity_on = [False]
cases = ["dsp01"]
cases = ["cnd01"]

# Model units

Expand Down Expand Up @@ -293,14 +293,14 @@ def build_models(idx, test):

# Instantiating MODFLOW 6 transport dispersion package
if dispersivity != 0:
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe,
xt3d_off=True,
alh=dispersivity,
ath1=dispersivity,
ktw=0.5918,
kts=0.2700,
filename="{}.dsp".format(gwename),
filename="{}.cnd".format(gwename),
)

# Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ def build_models(idx, test):
)

# Instantiating MODFLOW 6 transport dispersion package
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe1,
xt3d_off=False,
alh=dispersivity,
Expand All @@ -281,8 +281,8 @@ def build_models(idx, test):
# ktw=0.0,
kts=0.2700 * 86400,
# kts=0.0,
pname="DSP-2",
filename="{}.dsp".format(gwename1),
pname="CND-2",
filename="{}.cnd".format(gwename1),
)

# Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,15 +313,15 @@ def build_models(idx, test):
)

# Instantiating MODFLOW 6 transport dispersion package
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe1,
xt3d_off=True,
alh=dispersivity,
ath1=dispersivity,
ktw=0.5918 * 86400,
kts=0.2700 * 86400,
pname="DSP-2",
filename="{}.dsp".format(gwename1),
pname="CND-2",
filename="{}.cnd".format(gwename1),
)

# Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -471,15 +471,15 @@ def build_models(idx, test):

# Instantiating MODFLOW 6 transport dispersion package
if dispersivity != 0:
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe,
xt3d_off=False,
alh=dispersivity,
ath1=dispersivity,
ktw=ktw,
kts=kts,
pname="DSP-3",
filename="{}.dsp".format(gwename),
pname="CND-3",
filename="{}.cnd".format(gwename),
)

# Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
Expand Down
4 changes: 2 additions & 2 deletions autotest/test_gwe_vs_gwt.py
Original file line number Diff line number Diff line change
Expand Up @@ -309,13 +309,13 @@ def build_models(idx, test):

# Instantiating MODFLOW 6 heat transport dispersion package
if al != 0:
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe,
alh=al,
ath1=ath1,
ktw=0.5918,
kts=0.2700,
filename="{}.dsp".format(gwename),
filename="{}.cnd".format(gwename),
)

# Instantiating MODFLOW 6 heat transport mass storage package (formerly "reaction" package in MT3DMS)
Expand Down
8 changes: 4 additions & 4 deletions autotest/test_gwegwe_exchng_with_comp2gwt.py
Original file line number Diff line number Diff line change
Expand Up @@ -571,13 +571,13 @@ def add_upper_gwemodel(sim, scheme):

# Instantiating MODFLOW 6 heat transport dispersion package
if al != 0:
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe,
alh=al,
ath1=ath1,
ktw=0.5918,
kts=0.2700,
filename="{}.dsp".format(mname),
filename="{}.cnd".format(mname),
)

# Instantiating MODFLOW 6 transport mass storage package
Expand Down Expand Up @@ -649,13 +649,13 @@ def add_lower_gwemodel(sim, scheme):

# Instantiating MODFLOW 6 heat transport dispersion package
if al != 0:
flopy.mf6.ModflowGwedsp(
flopy.mf6.ModflowGwecnd(
gwe,
alh=al,
ath1=ath1,
ktw=0.5918,
kts=0.2700,
filename="{}.dsp".format(mname),
filename="{}.cnd".format(mname),
)

# Instantiating MODFLOW 6 transport mass storage package
Expand Down
17 changes: 17 additions & 0 deletions doc/mf6io/gwe/cnd.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Conduction (CND) Package information is read from the file that is specified by ``CND6'' as the file type. Only one CND Package can be specified for a GWE model. The CND Package is based on the mathematical formulation presented for the XT3D option of the NPF Package available to represent full three-dimensional anisotropy in groundwater flow. XT3D can be computationally expensive and can be turned off to use a simplified and approximate form of the dispersion equations that also account for conduction in a heat transport model. For most problems, however, XT3D will be required to accurately represent conduction and dispersion.

\vspace{5mm}
\subsubsection{Structure of Blocks}
\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-cnd-options.dat}
\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-cnd-griddata.dat}

\vspace{5mm}
\subsubsection{Explanation of Variables}
\begin{description}
\input{./mf6ivar/tex/gwe-cnd-desc.tex}
\end{description}

\vspace{5mm}
\subsubsection{Example Input File}
\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwe-cnd-example.dat}

17 changes: 0 additions & 17 deletions doc/mf6io/gwe/dsp.tex

This file was deleted.

4 changes: 2 additions & 2 deletions doc/mf6io/gwe/gwe.tex
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ \subsection{Advection (ADV) Package}
\input{gwe/adv}

\newpage
\subsection{Dispersion (DSP) Package}
\input{gwe/dsp}
\subsection{Conduction (CND) Package}
\input{gwe/cnd}

\newpage
\subsection{Energy Storage and Transfer (EST) Package}
Expand Down
4 changes: 2 additions & 2 deletions doc/mf6io/mf6ivar/dfn/exg-gwegwe.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ longname advective scheme
description scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme.

block options
name dsp_xt3d_off
name cnd_xt3d_off
type keyword
shape
reader urword
Expand All @@ -81,7 +81,7 @@ longname deactivate xt3d
description deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange.

block options
name dsp_xt3d_rhs
name cnd_xt3d_rhs
type keyword
shape
reader urword
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# --------------------- gwe dsp options ---------------------
# --------------------- gwe cnd options ---------------------

block options
name xt3d_off
Expand All @@ -18,7 +18,7 @@ optional true
longname xt3d on right-hand side
description add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations.

# --------------------- gwe dsp griddata ---------------------
# --------------------- gwe cnd griddata ---------------------

block griddata
name alh
Expand Down
18 changes: 9 additions & 9 deletions doc/mf6io/mf6ivar/md/mf6ivar.md
Original file line number Diff line number Diff line change
Expand Up @@ -1185,6 +1185,15 @@
| GWT | API | OPTIONS | MOVER | KEYWORD | keyword to indicate that this instance of the api boundary Package can be used with the Water Mover (MVR) Package. When the MOVER option is specified, additional memory is allocated within the package to store the available, provided, and received water. |
| GWT | API | DIMENSIONS | MAXBOUND | INTEGER | integer value specifying the maximum number of api boundary cells that will be specified for use during any stress period. |
| GWE | ADV | OPTIONS | SCHEME | STRING | scheme used to solve the advection term. Can be upstream, central, or TVD. If not specified, upstream weighting is the default weighting scheme. |
| GWE | CND | OPTIONS | XT3D_OFF | KEYWORD | deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on. |
| GWE | CND | OPTIONS | XT3D_RHS | KEYWORD | add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations. |
| GWE | CND | GRIDDATA | ALH | DOUBLE PRECISION (NODES) | longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required. |
| GWE | CND | GRIDDATA | ALV | DOUBLE PRECISION (NODES) | longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH. |
| GWE | CND | GRIDDATA | ATH1 | DOUBLE PRECISION (NODES) | transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required. |
| GWE | CND | GRIDDATA | ATH2 | DOUBLE PRECISION (NODES) | transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1. |
| GWE | CND | GRIDDATA | ATV | DOUBLE PRECISION (NODES) | transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2. |
| GWE | CND | GRIDDATA | KTW | DOUBLE PRECISION (NODES) | thermal conductivity of the simulated fluid |
| GWE | CND | GRIDDATA | KTS | DOUBLE PRECISION (NODES) | thermal conductivity of the aquifer material |
| GWE | CTP | OPTIONS | AUXILIARY | STRING (NAUX) | defines an array of one or more auxiliary variable names. There is no limit on the number of auxiliary variables that can be provided on this line; however, lists of information provided in subsequent blocks must have a column of data for each auxiliary variable name defined here. The number of auxiliary variables detected on this line determines the value for naux. Comments cannot be provided anywhere on this line as they will be interpreted as auxiliary variable names. Auxiliary variables may not be used by the package, but they will be available for use by other parts of the program. The program will terminate with an error if auxiliary variables are specified on more than one line in the options block. |
| GWE | CTP | OPTIONS | AUXMULTNAME | STRING | name of auxiliary variable to be used as multiplier of temperature value. |
| GWE | CTP | OPTIONS | BOUNDNAMES | KEYWORD | keyword to indicate that boundary names may be provided with the list of constant temperature cells. |
Expand Down Expand Up @@ -1261,15 +1270,6 @@
| GWE | DISU | CELL2D | YC | DOUBLE PRECISION | is the y-coordinate for the cell center. |
| GWE | DISU | CELL2D | NCVERT | INTEGER | is the number of vertices required to define the cell. There may be a different number of vertices for each cell. |
| GWE | DISU | CELL2D | ICVERT | INTEGER (NCVERT) | is an array of integer values containing vertex numbers (in the VERTICES block) used to define the cell. Vertices must be listed in clockwise order. |
| GWE | DSP | OPTIONS | XT3D_OFF | KEYWORD | deactivate the xt3d method and use the faster and less accurate approximation. This option may provide a fast and accurate solution under some circumstances, such as when flow aligns with the model grid, there is no mechanical dispersion, or when the longitudinal and transverse dispersivities are equal. This option may also be used to assess the computational demand of the XT3D approach by noting the run time differences with and without this option on. |
| GWE | DSP | OPTIONS | XT3D_RHS | KEYWORD | add xt3d terms to right-hand side, when possible. This option uses less memory, but may require more iterations. |
| GWE | DSP | GRIDDATA | ALH | DOUBLE PRECISION (NODES) | longitudinal dispersivity in horizontal direction. If flow is strictly horizontal, then this is the longitudinal dispersivity that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required. |
| GWE | DSP | GRIDDATA | ALV | DOUBLE PRECISION (NODES) | longitudinal dispersivity in vertical direction. If flow is strictly vertical, then this is the longitudinal dispsersivity value that will be used. If flow is not strictly horizontal or strictly vertical, then the longitudinal dispersivity is a function of both ALH and ALV. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ALH. |
| GWE | DSP | GRIDDATA | ATH1 | DOUBLE PRECISION (NODES) | transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the second ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the y direction. If mechanical dispersion is represented (by specifying any dispersivity values) then this array is required. |
| GWE | DSP | GRIDDATA | ATH2 | DOUBLE PRECISION (NODES) | transverse dispersivity in horizontal direction. This is the transverse dispersivity value for the third ellipsoid axis. If flow is strictly horizontal and directed in the x direction (along a row for a regular grid), then this value controls spreading in the z direction. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH1. |
| GWE | DSP | GRIDDATA | ATV | DOUBLE PRECISION (NODES) | transverse dispersivity when flow is in vertical direction. If flow is strictly vertical and directed in the z direction, then this value controls spreading in the x and y directions. If this value is not specified and mechanical dispersion is represented, then this array is set equal to ATH2. |
| GWE | DSP | GRIDDATA | KTW | DOUBLE PRECISION (NODES) | thermal conductivity of the simulated fluid |
| GWE | DSP | GRIDDATA | KTS | DOUBLE PRECISION (NODES) | thermal conductivity of the aquifer material |
| GWE | IC | GRIDDATA | STRT | DOUBLE PRECISION (NODES) | is the initial (starting) temperature---that is, the temperature at the beginning of the GWE Model simulation. STRT must be specified for all GWE Model simulations. One value is read for every model cell. |
| GWE | EST | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that EST flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. |
| GWE | EST | OPTIONS | ZERO_ORDER_DECAY | KEYWORD | 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. |
Expand Down
2 changes: 1 addition & 1 deletion doc/mf6io/mf6ivar/mf6ivar.py
Original file line number Diff line number Diff line change
Expand Up @@ -740,11 +740,11 @@ def write_appendix(texdir, allblocks):
"gwt-mvt",
"gwt-api",
"gwe-adv",
"gwe-cnd",
"gwe-ctp",
"gwe-dis",
"gwe-disv",
"gwe-disu",
"gwe-dsp",
"gwe-ic",
"gwe-est",
"gwe-nam",
Expand Down
6 changes: 3 additions & 3 deletions doc/mf6io/mf6ivar/tex/appendixA.tex
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,9 @@
\hline
GWE & ADV & OPTIONS & yes \\
\hline
GWE & CND & OPTIONS & yes \\
GWE & CND & GRIDDATA & no \\
\hline
GWE & CTP & OPTIONS & yes \\
GWE & CTP & DIMENSIONS & yes \\
GWE & CTP & PERIOD & yes \\
Expand All @@ -267,9 +270,6 @@
GWE & DISU & VERTICES & yes \\
GWE & DISU & CELL2D & yes \\
\hline
GWE & DSP & OPTIONS & yes \\
GWE & DSP & GRIDDATA & no \\
\hline
GWE & IC & GRIDDATA & no \\
\hline
GWE & EST & OPTIONS & yes \\
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions make/makefile
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,11 @@ $(OBJDIR)/gwf3dis8idm.o \
$(OBJDIR)/gwf3chd8idm.o \
$(OBJDIR)/gwe1idm.o \
$(OBJDIR)/gwe1ic1idm.o \
$(OBJDIR)/gwe1dsp1idm.o \
$(OBJDIR)/gwe1disv1idm.o \
$(OBJDIR)/gwe1disu1idm.o \
$(OBJDIR)/gwe1dis1idm.o \
$(OBJDIR)/gwe1ctp1idm.o \
$(OBJDIR)/gwe1cnd1idm.o \
$(OBJDIR)/gwtgwtidm.o \
$(OBJDIR)/gwfgwtidm.o \
$(OBJDIR)/gwfgwfidm.o \
Expand Down Expand Up @@ -245,7 +245,7 @@ $(OBJDIR)/Mover.o \
$(OBJDIR)/GwfMvrPeriodData.o \
$(OBJDIR)/ims8misc.o \
$(OBJDIR)/GwfBuyInputData.o \
$(OBJDIR)/GweDspOptions.o \
$(OBJDIR)/GweCndOptions.o \
$(OBJDIR)/VirtualSolution.o \
$(OBJDIR)/SparseMatrix.o \
$(OBJDIR)/LinearSolverBase.o \
Expand Down Expand Up @@ -279,8 +279,8 @@ $(OBJDIR)/GhostNode.o \
$(OBJDIR)/gwf3evt8.o \
$(OBJDIR)/gwf3chd8.o \
$(OBJDIR)/gwe1est1.o \
$(OBJDIR)/gwe1dsp1.o \
$(OBJDIR)/gwe1ctp1.o \
$(OBJDIR)/gwe1cnd1.o \
$(OBJDIR)/RouterBase.o \
$(OBJDIR)/ImsLinearSolver.o \
$(OBJDIR)/ims8base.o \
Expand Down
6 changes: 3 additions & 3 deletions msvs/mf6core.vfproj
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,13 @@
<File RelativePath="..\src\Model\Geometry\RectangularGeometry.f90"/></Filter>
<Filter Name="GroundWaterEnergy">
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1cnd1.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1cnd1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1ctp1.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1ctp1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1dis1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1disu1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1disv1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1dsp1.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1dsp1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1est1.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1ic1idm.f90"/>
<File RelativePath="..\src\Model\GroundWaterEnergy\gwe1idm.f90"/></Filter>
Expand Down Expand Up @@ -210,7 +210,7 @@
<File RelativePath="..\src\Model\ModelUtilities\DiscretizationBase.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\DisvGeom.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\FlowModelInterface.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\GweDspOptions.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\GweCndOptions.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\GweInputData.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\GwfBuyInputData.f90"/>
<File RelativePath="..\src\Model\ModelUtilities\GwfMvrPeriodData.f90"/>
Expand Down
Loading

0 comments on commit fea5a04

Please sign in to comment.