feat(sfr): add alternative length_conversion and time_conversion varibles

autotest/test_gwf_auxvars.py

@@ -167,7 +167,8 @@ def build_model(idx, dir):
         print_flows=True,
         save_flows=True,
         budget_filerecord="aux01.sfr.bud",
-        unit_conversion=128390.00,
+        length_conversion=3.281348587,
+        time_conversion=86400.0,
         nreaches=len(packagedata),
         packagedata=packagedata,
         auxiliary=["aux1", "aux2"],

doc/ReleaseNotes/v6.5.0.tex

@@ -6,6 +6,7 @@
 	\underline{NEW FUNCTIONALITY}
 	\begin{itemize}
 		\item The sorption formulation for the Groundwater Transport (GWT) model was modified for simulations involving a mobile domain and one or more immobile domains.  The modifications do not affect GWT Models without the Immobile Storage and Transfer (IST) Package or GWT models without sorption.  Prior to these changes, the multi-domain sorption formulation required the bulk density to be specified in both the Mobile Storage and Transfer (MST) Package and the IST Package.  To generalize the formulation, the definition for bulk density in the MST Package was changed to be the mass of aquifer solid material in the mobile domain per unit volume of aquifer.  The bulk density specified in the IST Package was changed to be the mass of aquifer solid material in the immobile domain per unit volume of aquifer.  For multi-domain GWT Models that include sorption (and prepared for MODFLOW version 6.4.1 or earlier), it will be necessary to change the bulk density values specified in the MST and IST Packages according to the new definitions.  A full description of the revised sorption formulation for multi-domain GWT Models is included in the MODFLOW 6 Supplemental Technical Information document included with the distribution.
+		\item Add LENGTH\_CONVERSION and TIME\_CONVERSION variables to replace the UNIT\_CONVERSION variable in the SFR Package input file. The LENGTH\_CONVERSION and TIME\_CONVERSION variables are used to convert user-specified Manning's roughness coefficients from SI units (sec/m$^{1/3}$) to model length and time units. LENGTH\_CONVERSION does not need to be specified if LENGTH\_UNITS are meters. TIME\_CONVERSION does not need to be specified if TIME\_UNITS are seconds. Warning messages will be issued if UNIT\_CONVERSION variable is specified. The model will terminate with an error if UNIT\_CONVERSION and LENGTH\_CONVERSION and TIME\_CONVERSION variables are specified. The UNIT\_CONVERSION variable in the SFR Package input file will eventually be deprecated. 
 	%	\item xxx
 	%	\item xxx
 	\end{itemize}
@@ -42,6 +43,7 @@
 	\underline{ADVANCED STRESS PACKAGES}
 	\begin{itemize}
 		\item Added additional convergence checks to the Streamflow Routing (SFR), Lake (LAK) and Unsaturated Zone Flow (UZF) Packages to ensure that flows from the Water Mover (MVR) Package meet solver tolerance.  Mover flows are converted into depths using the time step length and area, and the depths are compared to the Iterative Model Solution (IMS) DVCLOSE input parameter.  If a depth is greater than DVCLOSE, then the iteration is marked as not converged.  The maximum depth change between iterations and the advanced package feature number is written for each outer iteration to a comma-separated value file, provided the PACKAGE\_CONVERGENCE option is specified in the options block.
+
 	%	\item xxx
 	%	\item xxx
 	\end{itemize}

doc/mf6io/mf6io.bbl

@@ -1,248 +0,0 @@
-\begin{thebibliography}{35}
-\providecommand{\natexlab}[1]{#1}
-\expandafter\ifx\csname urlstyle\endcsname\relax
-  \providecommand{\doiagency}[1]{doi:\discretionary{}{}{}#1}\else
-  \providecommand{\doiagency}{doi:\discretionary{}{}{}\begingroup
-  \urlstyle{rm}\Url}\fi
-
-\bibitem[{Anderman and Hill(2000)}]{anderman2000modflow}
-Anderman, E.R., and Hill, M.C., 2000, MODFLOW-2000, the U.S. Geological Survey
-  modular ground-water model-documentation of the Hydrogeologic-Unit Flow (HUF)
-  Package: {U.S. Geological Survey Open-File Report 2000--342, 89 p.}
-
-\bibitem[{Anderman and Hill(2003)}]{anderman2003modflow}
-Anderman, E.R., and Hill, M.C., 2003, MODFLOW-2000, the U.S. Geological Survey
-  modular ground-water model---Three additions to the Hydrogeologic-Unit Flow
-  (HUF) Package: Alternative storage for the uppermost active cells, flows in
-  hydrogeologic units, and the hydraulic-conductivity depth-dependence (KDEP)
-  capability: {U.S. Geological Survey Open-File Report 2003--347, 36 p.}
-
-\bibitem[{Bakker and others(2013)Bakker, Schaars, Hughes, Langevin, and
-  Dausman}]{bakker2013documentation}
-Bakker, M., Schaars, F., Hughes, J.D., Langevin, C.D., and Dausman, A.M., 2013,
-  Documentation of the seawater intrusion (SWI2) package for MODFLOW: {U.S.
-  Geological Survey Techniques and Methods, book 6, chap. A46, 47 p.}, accessed
-  June 27, 2017, at \url{https://pubs.er.usgs.gov/publication/tm6A46}.
-
-\bibitem[{Banta(2000)}]{modflowdrtpack}
-Banta, E.R., 2000, MODFLOW-2000, the U.S. Geological Survey Modular
-  Ground-Water Model; documentation of packages for simulating
-  evapotranspiration with a segmented function (ETS1) and drains with return
-  flow (DRT1): {U.S. Geological Survey Open File Report 2000--466, 127 p}.
-
-\bibitem[{Banta(2011)}]{banta2011modflow}
-Banta, E.R., 2011, MODFLOW-CDSS, a version of MODFLOW-2005 with modifications
-  for Colorado Decision Support Systems: {U.S. Geological Survey Open-File
-  Report 2011--1213, 19 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/ofr20111213}.
-
-\bibitem[{Fenske and others(1996)Fenske, Leake, and
-  Prudic}]{fenske1996documentation}
-Fenske, J.P., Leake, S.A., and Prudic, D.E., 1996, Documentation of a computer
-  program (RES1) to simulate leakage from reservoirs using the modular
-  finite-difference ground-water flow model (MODFLOW): {U.S. Geological Survey
-  Open-File Report 96--364, 51 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/ofr96364}.
-
-\bibitem[{Halford and Hanson(2002)}]{halford2002}
-Halford, K.J., and Hanson, R.T., 2002, User guide for the drawdown-limited,
-  multi-node well (MNW) package for the U.S. Geological Survey's modular
-  three-dimensional finite-difference ground-water flow model, versions
-  MODFLOW-96 and MODFLOW-2000: {U.S. Geological Survey Open-File Report
-  02--293, 33 p.}
-
-\bibitem[{Hanson and Leake(1999)}]{hanson1999documentation}
-Hanson, R.T., and Leake, S.A., 1999, Documentation for HYDMOD---A program for
-  extracting and processing time-series data from the U.S. Geological Survey's
-  modular three-dimensional finite-difference ground-water flow model: {U.S.
-  Geological Survey Open-File Report 98--564, 57 p.}, accessed June 27, 2017,
-  at \url{https://pubs.er.usgs.gov/publication/ofr98564}.
-
-\bibitem[{Harbaugh(2005)}]{modflow2005}
-Harbaugh, A.W., 2005, MODFLOW-2005, the U.S. Geological Survey modular
-  ground-water model---the Ground-Water Flow Process: {U.S. Geological Survey
-  Techniques and Methods, book 6, chap. A16, variously paged}, accessed June
-  27, 2017, at \url{https://pubs.usgs.gov/tm/2005/tm6A16/}.
-
-\bibitem[{Hill(1990)}]{hill1990preconditioned}
-Hill, M.C., 1990, Preconditioned Conjugate-Gradient 2 (PCG2), a computer
-  program for solving ground-water flow equations: {U.S. Geological Survey
-  Water-Resources Investigations Report 90--4048, 25 p.}, accessed June 27,
-  2017, at \url{https://pubs.usgs.gov/wri/wrir_90-4048}.
-
-\bibitem[{Hill and others(2000)Hill, Banta, Harbaugh, and
-  Anderman}]{hill2000modflow}
-Hill, M.C., Banta, E.R., Harbaugh, A.W., and Anderman, E.R., 2000,
-  MODFLOW-2000, the U.S. Geological Survey modular ground-water model---User
-  guide to the observation, sensitivity, and parameter-estimation processes and
-  three post-processing programs: {U.S. Geological Survey Open-File Report
-  00--184, 210 p.}
-
-\bibitem[{Hoffmann and others(2003)Hoffmann, Leake, Galloway, and
-  Wilson}]{hoffmann2003modflow}
-Hoffmann, J., Leake, S.A., Galloway, D.L., and Wilson, A.M., 2003, MODFLOW-2000
-  Ground-Water Model---User Guide to the Subsidence and Aquifer-System
-  Compaction (SUB) Package: {U.S. Geological Survey Open-File Report 03--233,
-  44 p.}, accessed June 27, 2017, at
-  \url{https://pubs.usgs.gov/of/2003/ofr03-233/}.
-
-\bibitem[{Hsieh and Freckleton(1993)}]{hsieh1993hfb}
-Hsieh, P.A., and Freckleton, J.R., 1993, Documentation of a computer program to
-  simulate horizontal-flow barriers using the U.S. Geological Survey's modular
-  three-dimensional finite-difference ground-water flow model: {U.S. Geological
-  Survey Open-File Report 92--477, 32 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/ofr92477}.
-
-\bibitem[{Hughes and others(2012)Hughes, Langevin, Chartier, and
-  White}]{hughes2012documentation}
-Hughes, J.D., Langevin, C.D., Chartier, K.L., and White, J.T., 2012,
-  Documentation of the Surface-Water Routing (SWR1) Process for modeling
-  surface-water flow with the U.S. Geological Survey modular groundwater model
-  (MODFLOW-2005): {U.S. Geological Survey Techniques and Methods, book 6, chap.
-  A40 (Version 1.0), 113 p.}, accessed June 27, 2017, at
-  \url{https://pubs.usgs.gov/tm/6a40/}.
-
-\bibitem[{Hughes and others(2017)Hughes, Langevin, and
-  Banta}]{modflow6framework}
-Hughes, J.D., Langevin, C.D., and Banta, E.R., 2017, Documentation for the
-  MODFLOW 6 framework: {U.S. Geological Survey Techniques and Methods, book 6,
-  chap. A57, 36 p.}, \url{https://doi.org/10.3133/tm6A57}.
-
-\bibitem[{Hughes and others(2022{\natexlab{a}})Hughes, Russcher, Langevin,
-  Morway, and McDonald}]{modflow6api}
-Hughes, J.D., Russcher, M.J., Langevin, C.D., Morway, E.D., and McDonald, R.R.,
-  2022{\natexlab{a}}, The {MODFLOW Application Programming Interface} for
-  simulation control and software interoperability: Environmental Modelling \&
-  Software, v. 148, article 105257,
-  \url{https://doi.org/10.1016/j.envsoft.2021.105257}.
-
-\bibitem[{Hughes and others(2022{\natexlab{b}})Hughes, Leake, Galloway, and
-  White}]{modflow6csub}
-Hughes, J.D., Leake, S.A., Galloway, D.L., and White, J.T., 2022{\natexlab{b}},
-  Documentation for the Skeletal Storage, Compaction, and Subsidence (CSUB)
-  Package of MODFLOW 6: {U.S. Geological Survey Techniques and Methods, book 6,
-  chap. A62, 57 p.}, \url{https://doi.org/10.3133/tm6A62}.
-
-\bibitem[{Konikow and others(2009)Konikow, Hornberger, Halford, and
-  Hanson}]{konikow2009}
-Konikow, L.F., Hornberger, G.Z., Halford, K.J., and Hanson, R.T., 2009, Revised
-  multi-node well (MNW2) package for MODFLOW ground-water flow model: {U.S.
-  Geological Survey Techniques and Methods, book 6, chap. A30, 67 p.}, accessed
-  June 27, 2017, at \url{https://pubs.usgs.gov/tm/tm6a30/}.
-
-\bibitem[{Langevin and others(2008)Langevin, Thorne~Jr, Dausman, Sukop, and
-  Guo}]{langevin2008seawat}
-Langevin, C.D., Thorne~Jr, D.T., Dausman, A.M., Sukop, M.C., and Guo, W., 2008,
-  {SEAWAT} Version 4---A computer program for simulation of multi-species
-  solute and heat transport: {U.S. Geological Survey Techniques and Methods,
-  book 6, chap. A22, 39 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/tm6A22}.
-
-\bibitem[{Langevin and others(2017)Langevin, Hughes, Provost, Banta, Niswonger,
-  and Panday}]{modflow6gwf}
-Langevin, C.D., Hughes, J.D., Provost, A.M., Banta, E.R., Niswonger, R.G., and
-  Panday, S., 2017, Documentation for the MODFLOW 6 Groundwater Flow (GWF)
-  Model: {U.S. Geological Survey Techniques and Methods, book 6, chap. A55, 197
-  p.}, \url{https://doi.org/10.3133/tm6A55}.
-
-\bibitem[{Langevin and others(2020)Langevin, Panday, and
-  Provost}]{langevin2020hydraulic}
-Langevin, C.D., Panday, S., and Provost, A.M., 2020, Hydraulic-head formulation
-  for density-dependent flow and transport: Groundwater, v.~58, no.~3,
-  p.~349--362.
-
-\bibitem[{Langevin and others(2022)Langevin, Provost, Panday, and
-  Hughes}]{modflow6gwt}
-Langevin, C.D., Provost, A.M., Panday, S., and Hughes, J.D., 2022,
-  Documentation for the MODFLOW 6 Groundwater Transport (GWT) Model: {U.S.
-  Geological Survey Techniques and Methods, book 6, chap. A61, 56 p.},
-  \url{https://doi.org/10.3133/tm6A61}.
-
-\bibitem[{Leake and Galloway(2007)}]{leake2007modflow}
-Leake, S.A., and Galloway, D.L., 2007, MODFLOW Ground-water model---User guide
-  to the Subsidence and Aquifer-System Compaction Package (SUB-WT) for
-  Water-Table Aquifers: {U.S. Geological Survey Techniques and Methods, book 6,
-  chap. A23, 42 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/tm6A23}.
-
-\bibitem[{Leake and Lilly(1997)}]{leake1997documentation}
-Leake, S.A., and Lilly, M.R., 1997, Documentation of computer program (FHB1)
-  for assignment of transient specified-flow and specified-head boundaries in
-  applications of the modular finite-diference ground-water flow model
-  (MODFLOW): {U.S. Geological Survey Open-File Report 97--571, 50 p.}, accessed
-  June 27, 2017, at \url{https://pubs.er.usgs.gov/publication/ofr97571}.
-
-\bibitem[{Maddock and others(2012)Maddock, Baird, Hanson, Schmid, and
-  Ajami}]{modflowripetpack}
-Maddock, Thomas, I., Baird, K.J., Hanson, R.T., Schmid, W., and Ajami, H.,
-  2012, RIP-ET---A Riparian Evapotranspiration Package for MODFLOW-2005: {U.S.
-  Geological Survey Techniques and Methods, book 6, chap. A39, 76 p.}, accessed
-  June 27, 2017, at \url{https://pubs.usgs.gov/tm/tm6a39/}.
-
-\bibitem[{Merritt and Konikow(2000)}]{modflowlak3pack}
-Merritt, M.L., and Konikow, L.F., 2000, Documentation of a computer program to
-  simulate lake-aquifer interaction using the MODFLOW ground-water flow model
-  and the MOC3D solute-transport model: {U.S. Geological Survey Water-Resources
-  Investigations Report 00--4167, 146 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/wri004167}.
-
-\bibitem[{Niswonger and Prudic(2005)}]{modflowsfr2pack}
-Niswonger, R.G., and Prudic, D.E., 2005, Documentation of the
-  Streamflow-Routing (SFR2) Package to include unsaturated flow beneath
-  streams---A modification to SFR1: {U.S. Geological Survey Techniques and
-  Methods, book 6, chap. A13, 50 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/tm6A13}.
-
-\bibitem[{Niswonger and others(2006)Niswonger, Prudic, and Regan}]{UZF}
-Niswonger, R.G., Prudic, D.E., and Regan, R.S., 2006, Documentation of the
-  Unsaturated-Zone Flow (UZF1) Package for modeling unsaturated flow between
-  the land surface and the water table with {MODFLOW}-2005: {U.S. Geological
-  Survey Techniques and Methods, book 6, chap. A19, 62 p.}, accessed June 27,
-  2017, at \url{https://pubs.usgs.gov/tm/2006/tm6a19/}.
-
-\bibitem[{Panday and others(2013)Panday, Langevin, Niswonger, Ibaraki, and
-  Hughes}]{modflowusg}
-Panday, S., Langevin, C.D., Niswonger, R.G., Ibaraki, M., and Hughes, J.D.,
-  2013, MODFLOW-USG version 1---An unstructured grid version of MODFLOW for
-  simulating groundwater flow and tightly coupled processes using a control
-  volume finite-difference formulation: {U.S. Geological Survey Techniques and
-  Methods, book 6, chap. A45, 66 p.}, accessed June 27, 2017, at
-  \url{https://pubs.usgs.gov/tm/06/a45/}.
-
-\bibitem[{Provost and others(2017)Provost, Langevin, and Hughes}]{modflow6xt3d}
-Provost, A.M., Langevin, C.D., and Hughes, J.D., 2017, Documentation for the
-  ``XT3D'' Option in the Node Property Flow (NPF) Package of MODFLOW 6: {U.S.
-  Geological Survey Techniques and Methods, book 6, chap. A56, 46 p.},
-  \url{https://doi.org/10.3133/tm6A56}.
-
-\bibitem[{Prudic(1989)}]{prudic1989str}
-Prudic, D.E., 1989, Documentation of a computer program to simulate
-  stream-aquifer relations using a modular, finite-difference, ground-water
-  flow model: {U.S. Geological Survey Open-File Report 88--729, 113 p.},
-  accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/ofr88729}.
-
-\bibitem[{Prudic and others(2004)Prudic, Konikow, and Banta}]{modflowsfr1pack}
-Prudic, D.E., Konikow, L.F., and Banta, E.R., 2004, A New Streamflow-Routing
-  (SFR1) Package to simulate stream-aquifer interaction with MODFLOW-2000:
-  {U.S. Geological Survey Open File Report 2004--1042, 104 p.}, accessed June
-  27, 2017, at \url{https://pubs.er.usgs.gov/publication/ofr20041042}.
-
-\bibitem[{Voss(1984)}]{Voss1984sutra}
-Voss, C.I., 1984, SUTRA---A finite-element simulation model for
-  saturated-unsaturated fluid-density-dependent ground-water flow with energy
-  transport or chemically-reactive single-species solute transport: {U.S.
-  Geological Survey Water-Resources Investigations Report 84--4369, 409 p.}
-
-\bibitem[{Zheng(2010)}]{zheng2010supplemental}
-Zheng, C., 2010, MT3DMS v5.3, Supplemental User's Guide: {Technical Report
-  Prepared for the U.S. Army Corps of Engineers, 51 p.}
-
-\bibitem[{Zheng and others(2001)Zheng, Hill, and Hsieh}]{zheng2001modflow}
-Zheng, C., Hill, M.C., and Hsieh, P.A., 2001, MODFLOW-2000, the U.S. Geological
-  Survey Modular Ground-Water Model---User guide to the LMT6 package, the
-  linkage with MT3DMS for multi-species mass transport modeling: {U.S.
-  Geological Survey Open-File Report 01--82, 43 p.}, accessed June 27, 2017, at
-  \url{https://pubs.er.usgs.gov/publication/ofr0182}.
-
-\end{thebibliography}

doc/mf6io/mf6ivar/dfn/gwf-lak.dfn

@@ -291,15 +291,15 @@ type double precision
 reader urword
 optional true
 longname time conversion factor
-description value that is used in converting outlet flow terms that use Manning's equation or gravitational acceleration to consistent time units. TIME\_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME\_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. CONVTIME does not need to be specified if no lake outlets are specified or TIME\_UNITS are seconds.
+description real value that is used to convert user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from seconds to model time units. TIME\_CONVERSION should be set to 1.0, 60.0, 3,600.0, 86,400.0, and 31,557,600.0 when using time units (TIME\_UNITS) of seconds, minutes, hours, days, or years in the simulation, respectively. CONVTIME does not need to be specified if no lake outlets are specified or TIME\_UNITS are seconds.
 
 block options
 name length_conversion
 type double precision
 reader urword
 optional true
 longname length conversion factor
-description real value that is used in converting outlet flow terms that use Manning's equation or gravitational acceleration to consistent length units. LENGTH\_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH\_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH\_CONVERSION does not need to be specified if no lake outlets are specified or LENGTH\_UNITS are meters.
+description real value that is used to convert outlet user-specified Manning's roughness coefficients or gravitational acceleration used to calculate outlet flows from meters to model length units. LENGTH\_CONVERSION should be set to 3.28081, 1.0, and 100.0 when using length units (LENGTH\_UNITS) of feet, meters, or centimeters in the simulation, respectively. LENGTH\_CONVERSION does not need to be specified if no lake outlets are specified or LENGTH\_UNITS are meters.
 
 
 # --------------------- gwf lak dimensions ---------------------