Rebrand energy storage and transfer package acronym to EST

autotest/test_gwe_drycell_conduction0.py

@@ -286,15 +286,15 @@ def build_models(idx, test):
     )
 
     # Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe1,
         save_flows=True,
         porosity=prsity,
         cps=760.0,
         rhos=1500.0,
         packagedata=[cpw, rhow, lhv],
-        pname="MST-2",
-        filename="{}.mst".format(gwename1),
+        pname="EST-2",
+        filename="{}.est".format(gwename1),
     )
 
     # Instantiating MODFLOW 6 heat transport source-sink mixing package

autotest/test_gwe_drycell_conduction1.py

@@ -325,15 +325,15 @@ def build_models(idx, test):
     )
 
     # Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe1,
         save_flows=True,
         porosity=prsity,
         cps=760.0,
         rhos=1500.0,
         packagedata=[cpw, rhow, lhv],
-        pname="MST-2",
-        filename="{}.mst".format(gwename1),
+        pname="EST-2",
+        filename="{}.est".format(gwename1),
     )
 
     # Instantiate MODFLOW 6 heat transport output control package

autotest/test_gwe_drycell_conduction2.py

@@ -483,15 +483,15 @@ def build_models(idx, test):
         )
 
     # Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe,
         save_flows=True,
         porosity=prsity,
         cps=cps,
         rhos=rhos,
         packagedata=[cpw, rhow, lhv],
-        pname="MST-3",
-        filename="{}.mst".format(gwename),
+        pname="EST-3",
+        filename="{}.est".format(gwename),
     )
 
     # Instantiating MODFLOW 6 transport source-sink mixing package

autotest/test_gwe_dsp.py

@@ -304,14 +304,14 @@ def build_models(idx, test):
         )
 
     # Instantiating MODFLOW 6 transport mass storage package (formerly "reaction" package in MT3DMS)
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe,
         save_flows=True,
         porosity=prsity,
         cps=760.0,
         rhos=1500.0,
         packagedata=[cpw, rhow, lhv],
-        filename="{}.mst".format(gwename),
+        filename="{}.est".format(gwename),
     )
 
     # Instantiating MODFLOW 6 transport constant concentration package

autotest/test_gwe_vs_gwt.py

@@ -319,13 +319,13 @@ def build_models(idx, test):
         )
 
     # Instantiating MODFLOW 6 heat transport mass storage package (formerly "reaction" package in MT3DMS)
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe,
         porosity=prsity,
         cps=760.0,
         packagedata=[cpw, rhow, lhv],
         rhos=1500.0,
-        filename="{}.mst".format(gwename),
+        filename="{}.est".format(gwename),
     )
 
     # Instantiating MODFLOW 6 heat transport source-sink mixing package

autotest/test_gwegwe_exchng_with_comp2gwt.py

@@ -581,14 +581,14 @@ def add_upper_gwemodel(sim, scheme):
         )
 
     # Instantiating MODFLOW 6 transport mass storage package
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe,
         porosity=prsity,
         cps=cps,
         rhos=rhos,
         packagedata=[cpw, rhow, lhv],
-        pname="MST-UP",
-        filename="{}.mst".format(mname),
+        pname="EST-UP",
+        filename="{}.est".format(mname),
     )
 
     # Instantiating MODFLOW 6 heat transport source-sink mixing package
@@ -659,14 +659,14 @@ def add_lower_gwemodel(sim, scheme):
         )
 
     # Instantiating MODFLOW 6 transport mass storage package
-    flopy.mf6.ModflowGwemst(
+    flopy.mf6.ModflowGweest(
         gwe,
         porosity=prsity,
         cps=cps,
         rhos=rhos,
         packagedata=[cpw, rhow, lhv],
-        pname="MST-LO",
-        filename="{}.mst".format(mname),
+        pname="EST-LO",
+        filename="{}.est".format(mname),
     )
 
     # Instantiating MODFLOW 6 heat transport source-sink mixing package

doc/mf6io/gwe/est.tex

@@ -0,0 +1,18 @@
+Energy Storage and Transfer (EST) Package information is read from the file that is specified by ``EST6'' as the file type.  Only one EST Package can be specified for a GWE model. 
+
+\vspace{5mm}
+\subsubsection{Structure of Blocks}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-est-options.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-est-griddata.dat}
+\lstinputlisting[style=blockdefinition]{./mf6ivar/tex/gwe-est-packagedata.dat}
+
+\vspace{5mm}
+\subsubsection{Explanation of Variables}
+\begin{description}
+\input{./mf6ivar/tex/gwe-est-desc.tex}
+\end{description}
+
+\vspace{5mm}
+\subsubsection{Example Input File}
+\lstinputlisting[style=inputfile]{./mf6ivar/examples/gwe-est-example.dat}
+

doc/mf6io/gwe/gwe.tex

@@ -47,7 +47,7 @@ \subsection{Information for Existing Heat Transport Modelers}
 
 \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 MST Package, but does not include an IST Package.  Heat transport-related parameters such as thermal conductivities and heat capacities are specified in the MST Package.
+\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 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.  
 
@@ -110,12 +110,12 @@ \subsection{Dispersion (DSP) Package}
 \input{gwe/dsp}
 
 \newpage
-\subsection{Source and Sink Mixing (SSM) Package}
-\input{gwe/ssm}
+\subsection{Energy Storage and Transfer (EST) Package}
+\input{gwe/est}
 
 \newpage
-\subsection{Mobile Storage and Transfer (MST) Package}
-\input{gwe/mst}
+\subsection{Source and Sink Mixing (SSM) Package}
+\input{gwe/ssm}
 
 \newpage
 \subsection{Constant Temperature (CTP) Package}

doc/mf6io/gwe/namefile.tex

@@ -31,7 +31,7 @@ \subsubsection{Explanation of Variables}
 ADV6 & Advection Package \\ 
 DSP6 & Dispersion Package \\ 
 SSM6 & Source and Sink Mixing Package \\ 
-MST6 & Mobile Storage and Transfer Package \\
+EST6 & Energy Storage and Transfer Package \\
 CTP6 & Constant Temperature Package & * \\ 
 OBS6 & Observations Option \\
 \hline 

doc/mf6io/mf6ivar/dfn/gwe-mst.dfn → doc/mf6io/mf6ivar/dfn/gwe-est.dfn

@@ -1,12 +1,12 @@
-# --------------------- gwe mst options ---------------------
+# --------------------- gwe est options ---------------------
 
 block options
 name save_flows
 type keyword
 reader urword
 optional true
 longname save calculated flows to budget file
-description REPLACE save_flows {'{#1}': 'MST'}
+description REPLACE save_flows {'{#1}': 'EST'}
 
 block options
 name zero_order_decay
@@ -22,9 +22,9 @@ type keyword
 reader urword
 optional true
 longname activate cooling associated with evaporation
-description is a text keyword to indicate that cooling associated with evaporation will occur.  Use of this keyword requires that LATHEATVAP are specified in the GRIDDATA block.  While the MST package does not simulate evaporation, multiple other packages in a GWE simulation may.  For example, evaporation may occur from the surface of streams or lakes.  Owing to the energy consumed by the change in phase, the latent heat of vaporization is required.
+description is a text keyword to indicate that cooling associated with evaporation will occur.  Use of this keyword requires that LATHEATVAP are specified in the GRIDDATA block.  While the EST package does not simulate evaporation, multiple other packages in a GWE simulation may.  For example, evaporation may occur from the surface of streams or lakes.  Owing to the energy consumed by the change in phase, the latent heat of vaporization is required.
 
-# --------------------- gwe mst griddata ---------------------
+# --------------------- gwe est griddata ---------------------
 
 block griddata
 name porosity
@@ -63,7 +63,7 @@ layered true
 longname density of aquifer material
 description is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation.  For example, if working in SI units, values may be entered as kg/m3. 
 
-# --------------------- gwe mst packagedata ---------------------
+# --------------------- gwe est packagedata ---------------------
 
 block packagedata
 name packagedata

doc/mf6io/mf6ivar/examples/gwe-mst-example.dat → doc/mf6io/mf6ivar/examples/gwe-est-example.dat

@@ -1,4 +1,5 @@
 BEGIN OPTIONS
+  LATENT_HEAT_VAPORIZATION
 END OPTIONS
 
 BEGIN GRIDDATA

doc/mf6io/mf6ivar/examples/gwe-nam-example.dat

@@ -5,7 +5,7 @@ END OPTIONS
 BEGIN PACKAGES
   DIS6       heat_transport.dis
   IC6        heat_transport.ic
-  MST6       heat_transport.mst
+  EST6       heat_transport.est
   ADV6       heat_transport.adv
   DSP6       heat_transport.dsp
   SSM6       heat_transport.ssm

doc/mf6io/mf6ivar/md/mf6ivar.md

@@ -1271,16 +1271,16 @@
 | 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 | MST | OPTIONS | SAVE_FLOWS | KEYWORD | keyword to indicate that MST flow terms will be written to the file specified with ``BUDGET FILEOUT'' in Output Control. |
-| GWE | MST | 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. |
-| GWE | MST | OPTIONS | LATENT_HEAT_VAPORIZATION | KEYWORD | is a text keyword to indicate that cooling associated with evaporation will occur.  Use of this keyword requires that LATHEATVAP are specified in the GRIDDATA block.  While the MST package does not simulate evaporation, multiple other packages in a GWE simulation may.  For example, evaporation may occur from the surface of streams or lakes.  Owing to the energy consumed by the change in phase, the latent heat of vaporization is required. |
-| GWE | MST | GRIDDATA | POROSITY | DOUBLE PRECISION (NODES) | is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume.  The GWE model does not support the concept of an immobile domain in the context of heat transport. |
-| GWE | MST | GRIDDATA | DECAY | DOUBLE PRECISION (NODES) | is the rate coefficient for zero-order decay for the aqueous phase of the mobile domain.  A negative value indicates heat (energy) production.  The dimensions of decay for zero-order decay is energy per length cubed per time.  Zero-order decay will have no effect on simulation results unless zero-order decay is specified in the options block. |
-| GWE | MST | GRIDDATA | CPS | DOUBLE PRECISION (NODES) | is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent). |
-| GWE | MST | GRIDDATA | RHOS | DOUBLE PRECISION (NODES) | is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation.  For example, if working in SI units, values may be entered as kg/m3. |
-| GWE | MST | PACKAGEDATA | CPW | DOUBLE PRECISION | is the mass-based heat capacity of the simulated fluid. For example, units of J/kg/C may be used (or equivalent). |
-| GWE | MST | PACKAGEDATA | RHOW | DOUBLE PRECISION | is a user-specified value of the density of water. Value will remain fixed for the entire simulation.  For example, if working in SI units, values may be entered as kg/m3. |
-| GWE | MST | PACKAGEDATA | LATHEATVAP | DOUBLE PRECISION | is the user-specified value for the latent heat of vaporization. For example, if working in SI units, values may be entered as kJ/kg. |
+| 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. |
+| GWE | EST | OPTIONS | LATENT_HEAT_VAPORIZATION | KEYWORD | is a text keyword to indicate that cooling associated with evaporation will occur.  Use of this keyword requires that LATHEATVAP are specified in the GRIDDATA block.  While the EST package does not simulate evaporation, multiple other packages in a GWE simulation may.  For example, evaporation may occur from the surface of streams or lakes.  Owing to the energy consumed by the change in phase, the latent heat of vaporization is required. |
+| GWE | EST | GRIDDATA | POROSITY | DOUBLE PRECISION (NODES) | is the mobile domain porosity, defined as the mobile domain pore volume per mobile domain volume.  The GWE model does not support the concept of an immobile domain in the context of heat transport. |
+| GWE | EST | GRIDDATA | DECAY | DOUBLE PRECISION (NODES) | is the rate coefficient for zero-order decay for the aqueous phase of the mobile domain.  A negative value indicates heat (energy) production.  The dimensions of decay for zero-order decay is energy per length cubed per time.  Zero-order decay will have no effect on simulation results unless zero-order decay is specified in the options block. |
+| GWE | EST | GRIDDATA | CPS | DOUBLE PRECISION (NODES) | is the mass-based heat capacity of dry solids (aquifer material). For example, units of J/kg/C may be used (or equivalent). |
+| GWE | EST | GRIDDATA | RHOS | DOUBLE PRECISION (NODES) | is a user-specified value of the density of aquifer material not considering the voids. Value will remain fixed for the entire simulation.  For example, if working in SI units, values may be entered as kg/m3. |
+| GWE | EST | PACKAGEDATA | CPW | DOUBLE PRECISION | is the mass-based heat capacity of the simulated fluid. For example, units of J/kg/C may be used (or equivalent). |
+| GWE | EST | PACKAGEDATA | RHOW | DOUBLE PRECISION | is a user-specified value of the density of water. Value will remain fixed for the entire simulation.  For example, if working in SI units, values may be entered as kg/m3. |
+| GWE | EST | PACKAGEDATA | LATHEATVAP | DOUBLE PRECISION | is the user-specified value for the latent heat of vaporization. For example, if working in SI units, values may be entered as kJ/kg. |
 | GWE | NAM | OPTIONS | LIST | STRING | is name of the listing file to create for this GWE model.  If not specified, then the name of the list file will be the basename of the GWE model name file and the ``.lst'' extension.  For example, if the GWE name file is called ``my.model.nam'' then the list file will be called ``my.model.lst''. |
 | GWE | NAM | OPTIONS | PRINT_INPUT | KEYWORD | keyword to indicate that the list of all model stress package information will be written to the listing file immediately after it is read. |
 | GWE | NAM | OPTIONS | PRINT_FLOWS | KEYWORD | keyword to indicate that the list of all model package flow rates will be printed to the listing file for every stress period time step in which ``BUDGET PRINT'' is specified in Output Control.  If there is no Output Control option and ``PRINT\_FLOWS'' is specified, then flow rates are printed for the last time step of each stress period. |