feature(ims): add additional solver output (#375)

Closes #375

autotest/test_gwf_csub_sub01.py

@@ -172,10 +172,12 @@ def get_model(idx, dir):
                  theta, kv, ini_stress]]
 
     opth = '{}.csub.obs'.format(name)
+    cnvgpth = '{}.csub.cnvg.csv'.format(name)
     csub = flopy.mf6.ModflowGwfcsub(gwf, head_based=True,
                                     compression_indices=ci,
                                     print_input=True,
                                     save_flows=True,
+                                    package_convergence_filerecord=cnvgpth,
                                     effective_stress_lag=True,
                                     ndelaycells=ndcell[idx],
                                     ninterbeds=1,

autotest/test_gwf_mvr01.py

@@ -120,8 +120,10 @@ def get_model(idx, dir):
         [3, 'status', 'active'],
         [4, 'status', 'active'],
     ]
+    cnvgpth = '{}.sfr.cnvg.csv'.format(name)
     sfr = flopy.mf6.ModflowGwfsfr(gwf, mover=True, nreaches=5,
                                   maximum_depth_change=1.e-5,
+                                  package_convergence_filerecord=cnvgpth,
                                   packagedata=packagedata,
                                   connectiondata=connectiondata,
                                   perioddata=perioddata, pname='sfr-1')
@@ -176,10 +178,12 @@ def get_model(idx, dir):
                         (0, 'width', '0.000000000000e+000'),
                         (0, 'slope', '1.000000000000e-003'),
                         (0, 'rough', '1.000000000000e-001')]
+    cnvgpth = '{}.lak.cnvg.csv'.format(name)
     lak = flopy.mf6.ModflowGwflak(gwf, mover=True, nlakes=nlakes,
                                   noutlets=noutlets,
                                   print_stage=True,
                                   print_flows=True,
+                                  package_convergence_filerecord=cnvgpth,
                                   packagedata=packagedata,
                                   connectiondata=connectiondata,
                                   outlets=outlets,
@@ -206,7 +210,11 @@ def get_model(idx, dir):
                   [6, 1.e-8, 0, 0, 0, 0, 0, 0],
                   [7, 1.e-8, 0, 0, 0, 0, 0, 0],
                   [8, 1.e-8, 0, 0, 0, 0, 0, 0], ]
-    uzf = flopy.mf6.ModflowGwfuzf(gwf, mover=True, nuzfcells=len(packagedata),
+    cnvgpth = '{}.uzf.cnvg.csv'.format(name)
+    uzf = flopy.mf6.ModflowGwfuzf(gwf,
+                                  mover=True,
+                                  package_convergence_filerecord=cnvgpth,
+                                  nuzfcells=len(packagedata),
                                   ntrailwaves=7, nwavesets=40,
                                   packagedata=packagedata,
                                   perioddata=perioddata, pname='uzf-1')

autotest/test_gwf_npf03_sfr.py

@@ -235,10 +235,12 @@ def get_model(idx, dir):
 
         pname = 'sfr{}'.format(jdx + 1)
         fn = '{}.{}.sfr'.format(mname, pname)
+        cnvgpth = '{}.sfr.cnvg.csv'.format(mname)
 
         sfr = flopy.mf6.ModflowGwfsfr(gwf, unit_conversion=unit_conv,
                                       print_stage=True,
                                       print_flows=True,
+                                      package_convergence_filerecord=cnvgpth,
                                       mover=True,
                                       nreaches=len(rchd),
                                       packagedata=rchd,

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

@@ -405,6 +405,38 @@ optional false
 longname file keyword
 description name of the binary output file to write z-displacement information.
 
+block options
+name package_convergence_filerecord
+type record package_convergence fileout package_convergence_filename
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name package_convergence
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname package_convergence keyword
+description keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+block options
+name package_convergence_filename
+type string
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma spaced values output file to write package convergence information.
+
 block options
 name ts_filerecord
 type record ts6 filein ts6_filename

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

@@ -127,6 +127,38 @@ optional false
 longname file keyword
 description name of the binary output file to write budget information.
 
+block options
+name package_convergence_filerecord
+type record package_convergence fileout package_convergence_filename
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name package_convergence
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname package_convergence keyword
+description keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+block options
+name package_convergence_filename
+type string
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma spaced values output file to write package convergence information.
+
 block options
 name ts_filerecord
 type record ts6 filein ts6_filename

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

@@ -127,6 +127,38 @@ optional false
 longname file keyword
 description name of the binary output file to write budget information.
 
+block options
+name package_convergence_filerecord
+type record package_convergence fileout package_convergence_filename
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name package_convergence
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname package_convergence keyword
+description keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+block options
+name package_convergence_filename
+type string
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma spaced values output file to write package convergence information.
+
 block options
 name ts_filerecord
 type record ts6 filein ts6_filename
@@ -487,7 +519,7 @@ tagged false
 in_record true
 reader urword
 longname iprior code
-description character string value that defines the the prioritization system for the diversion, such as when insufficient water is available to meet all diversion stipulations, and is used in conjunction with the value of FLOW value specified in the STRESS\_PERIOD\_DATA section. Available diversion options include:  (1) CPRIOR = `FRACTION', then the amount of the diversion is computed as a fraction of the streamflow leaving reach RNO ($Q_{DS}$); in this case, 0.0 $\le$ DIVFLOW $\le$ 1.0.  (2) CPRIOR = `EXCESS', a diversion is made only if $Q_{DS}$ for reach RNO exceeds the value of DIVFLOW. If this occurs, then the quantity of water diverted is the excess flow ($Q_{DS} -$ DIVFLOW) and $Q_{DS}$ from reach RNO is set equal to DIVFLOW. This represents a flood-control type of diversion, as described by Danskin and Hanson (2002). (3) CPRIOR = `THRESHOLD', then if $Q_{DS}$ in reach RNO is less than the specified diversion flow (DIVFLOW), no water is diverted from reach RNO. If $Q_{DS}$ in reach RNO is greater than or equal to (DIVFLOW), (DIVFLOW) is diverted and $Q_{DS}$ is set to the remainder ($Q_{DS} -$ DIVFLOW)). This approach assumes that once flow in the stream is sufficiently low, diversions from the stream cease, and is the `priority' algorithm that originally was programmed into the STR1 Package (Prudic, 1989).  (4) CPRIOR = `UPTO' -- if $Q_{DS}$ in reach RNO is greater than or equal to the specified diversion flow (DIVFLOW), $Q_{DS}$ is reduced by DIVFLOW. If $Q_{DS}$ in reach RNO is less than (DIVFLOW), DIVFLOW is set to $Q_{DS}$ and there will be no flow available for reaches connected to downstream end of reach RNO. 
+description character string value that defines the the prioritization system for the diversion, such as when insufficient water is available to meet all diversion stipulations, and is used in conjunction with the value of FLOW value specified in the STRESS\_PERIOD\_DATA section. Available diversion options include:  (1) CPRIOR = `FRACTION', then the amount of the diversion is computed as a fraction of the streamflow leaving reach RNO ($Q_{DS}$); in this case, 0.0 $\le$ DIVFLOW $\le$ 1.0.  (2) CPRIOR = `EXCESS', a diversion is made only if $Q_{DS}$ for reach RNO exceeds the value of DIVFLOW. If this occurs, then the quantity of water diverted is the excess flow ($Q_{DS} -$ DIVFLOW) and $Q_{DS}$ from reach RNO is set equal to DIVFLOW. This represents a flood-control type of diversion, as described by Danskin and Hanson (2002). (3) CPRIOR = `THRESHOLD', then if $Q_{DS}$ in reach RNO is less than the specified diversion flow (DIVFLOW), no water is diverted from reach RNO. If $Q_{DS}$ in reach RNO is greater than or equal to (DIVFLOW), (DIVFLOW) is diverted and $Q_{DS}$ is set to the remainder ($Q_{DS} -$ DIVFLOW)). This approach assumes that once flow in the stream is sufficiently low, diversions from the stream cease, and is the `priority' algorithm that originally was programmed into the STR1 Package (Prudic, 1989).  (4) CPRIOR = `UPTO' -- if $Q_{DS}$ in reach RNO is greater than or equal to the specified diversion flow (DIVFLOW), $Q_{DS}$ is reduced by DIVFLOW. If $Q_{DS}$ in reach RNO is less than (DIVFLOW), DIVFLOW is set to $Q_{DS}$ and there will be no flow available for reaches connected to downstream end of reach RNO.
 
 
 # --------------------- gwf sfr period ---------------------

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

@@ -95,6 +95,38 @@ optional false
 longname file keyword
 description name of the binary output file to write budget information.
 
+block options
+name package_convergence_filerecord
+type record package_convergence fileout package_convergence_filename
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name package_convergence
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname package_convergence keyword
+description keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+block options
+name package_convergence_filename
+type string
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the comma spaced values output file to write package convergence information.
+
 block options
 name ts_filerecord
 type record ts6 filein ts6_filename

doc/mf6io/mf6ivar/md/mf6ivar.md

@@ -210,6 +210,8 @@
 | GWF | CSUB | OPTIONS | COARSE_COMPACTION_FILENAME | STRING | name of the binary output file to write elastic coarse-grained material compaction information. |
 | GWF | CSUB | OPTIONS | ZDISPLACEMENT | KEYWORD | keyword to specify that record corresponds to the z-displacement binary file. |
 | GWF | CSUB | OPTIONS | ZDISPLACEMENT_FILENAME | STRING | name of the binary output file to write z-displacement information. |
+| GWF | CSUB | OPTIONS | PACKAGE_CONVERGENCE | KEYWORD | keyword to specify that record corresponds to the package convergence comma spaced values file. |
+| GWF | CSUB | OPTIONS | PACKAGE_CONVERGENCE_FILENAME | STRING | name of the comma spaced values output file to write package convergence information. |
 | GWF | CSUB | OPTIONS | TS6 | KEYWORD | keyword to specify that record corresponds to a time-series file. |
 | GWF | CSUB | OPTIONS | FILEIN | KEYWORD | keyword to specify that an input filename is expected next. |
 | GWF | CSUB | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. |
@@ -481,6 +483,8 @@
 | GWF | SFR | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. |
 | GWF | SFR | OPTIONS | FILEOUT | KEYWORD | keyword to specify that an output filename is expected next. |
 | GWF | SFR | OPTIONS | BUDGETFILE | STRING | name of the binary output file to write budget information. |
+| GWF | SFR | OPTIONS | PACKAGE_CONVERGENCE | KEYWORD | keyword to specify that record corresponds to the package convergence comma spaced values file. |
+| GWF | SFR | OPTIONS | PACKAGE_CONVERGENCE_FILENAME | STRING | name of the comma spaced values output file to write package convergence information. |
 | GWF | SFR | OPTIONS | TS6 | KEYWORD | keyword to specify that record corresponds to a time-series file. |
 | GWF | SFR | OPTIONS | FILEIN | KEYWORD | keyword to specify that an input filename is expected next. |
 | GWF | SFR | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. |
@@ -539,6 +543,8 @@
 | GWF | LAK | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. |
 | GWF | LAK | OPTIONS | FILEOUT | KEYWORD | keyword to specify that an output filename is expected next. |
 | GWF | LAK | OPTIONS | BUDGETFILE | STRING | name of the binary output file to write budget information. |
+| GWF | LAK | OPTIONS | PACKAGE_CONVERGENCE | KEYWORD | keyword to specify that record corresponds to the package convergence comma spaced values file. |
+| GWF | LAK | OPTIONS | PACKAGE_CONVERGENCE_FILENAME | STRING | name of the comma spaced values output file to write package convergence information. |
 | GWF | LAK | OPTIONS | TS6 | KEYWORD | keyword to specify that record corresponds to a time-series file. |
 | GWF | LAK | OPTIONS | FILEIN | KEYWORD | keyword to specify that an input filename is expected next. |
 | GWF | LAK | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. |
@@ -606,6 +612,8 @@
 | GWF | UZF | OPTIONS | BUDGET | KEYWORD | keyword to specify that record corresponds to the budget. |
 | GWF | UZF | OPTIONS | FILEOUT | KEYWORD | keyword to specify that an output filename is expected next. |
 | GWF | UZF | OPTIONS | BUDGETFILE | STRING | name of the binary output file to write budget information. |
+| GWF | UZF | OPTIONS | PACKAGE_CONVERGENCE | KEYWORD | keyword to specify that record corresponds to the package convergence comma spaced values file. |
+| GWF | UZF | OPTIONS | PACKAGE_CONVERGENCE_FILENAME | STRING | name of the comma spaced values output file to write package convergence information. |
 | GWF | UZF | OPTIONS | TS6 | KEYWORD | keyword to specify that record corresponds to a time-series file. |
 | GWF | UZF | OPTIONS | FILEIN | KEYWORD | keyword to specify that an input filename is expected next. |
 | GWF | UZF | OPTIONS | TS6_FILENAME | STRING | defines a time-series file defining time series that can be used to assign time-varying values. See the ``Time-Variable Input'' section for instructions on using the time-series capability. |

doc/mf6io/mf6ivar/tex/gwf-csub-desc.tex

@@ -67,6 +67,10 @@
 
 \item \texttt{zdisplacement\_filename}---name of the binary output file to write z-displacement information.
 
+\item \texttt{PACKAGE\_CONVERGENCE}---keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+\item \texttt{package\_convergence\_filename}---name of the comma spaced values output file to write package convergence information.
+
 \item \texttt{TS6}---keyword to specify that record corresponds to a time-series file.
 
 \item \texttt{FILEIN}---keyword to specify that an input filename is expected next.

doc/mf6io/mf6ivar/tex/gwf-csub-options.dat

@@ -22,6 +22,7 @@ BEGIN OPTIONS
   [COMPACTION_INTERBED FILEOUT <interbed_compaction_filename>]
   [COMPACTION_COARSE FILEOUT <coarse_compaction_filename>]
   [ZDISPLACEMENT FILEOUT <zdisplacement_filename>]
+  [PACKAGE_CONVERGENCE FILEOUT <package_convergence_filename>]
   [TS6 FILEIN <ts6_filename>]
   [OBS6 FILEIN <obs6_filename>]
 END OPTIONS

doc/mf6io/mf6ivar/tex/gwf-lak-desc.tex

@@ -25,6 +25,10 @@
 
 \item \texttt{budgetfile}---name of the binary output file to write budget information.
 
+\item \texttt{PACKAGE\_CONVERGENCE}---keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+\item \texttt{package\_convergence\_filename}---name of the comma spaced values output file to write package convergence information.
+
 \item \texttt{TS6}---keyword to specify that record corresponds to a time-series file.
 
 \item \texttt{FILEIN}---keyword to specify that an input filename is expected next.

doc/mf6io/mf6ivar/tex/gwf-lak-options.dat

@@ -7,6 +7,7 @@ BEGIN OPTIONS
   [SAVE_FLOWS]
   [STAGE FILEOUT <stagefile>]
   [BUDGET FILEOUT <budgetfile>]
+  [PACKAGE_CONVERGENCE FILEOUT <package_convergence_filename>]
   [TS6 FILEIN <ts6_filename>]
   [OBS6 FILEIN <obs6_filename>]
   [MOVER]

doc/mf6io/mf6ivar/tex/gwf-sfr-desc.tex

@@ -25,6 +25,10 @@
 
 \item \texttt{budgetfile}---name of the binary output file to write budget information.
 
+\item \texttt{PACKAGE\_CONVERGENCE}---keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+\item \texttt{package\_convergence\_filename}---name of the comma spaced values output file to write package convergence information.
+
 \item \texttt{TS6}---keyword to specify that record corresponds to a time-series file.
 
 \item \texttt{FILEIN}---keyword to specify that an input filename is expected next.

doc/mf6io/mf6ivar/tex/gwf-sfr-options.dat

@@ -7,6 +7,7 @@ BEGIN OPTIONS
   [SAVE_FLOWS]
   [STAGE FILEOUT <stagefile>]
   [BUDGET FILEOUT <budgetfile>]
+  [PACKAGE_CONVERGENCE FILEOUT <package_convergence_filename>]
   [TS6 FILEIN <ts6_filename>]
   [OBS6 FILEIN <obs6_filename>]
   [MOVER]

doc/mf6io/mf6ivar/tex/gwf-uzf-desc.tex

@@ -21,6 +21,10 @@
 
 \item \texttt{budgetfile}---name of the binary output file to write budget information.
 
+\item \texttt{PACKAGE\_CONVERGENCE}---keyword to specify that record corresponds to the package convergence comma spaced values file.
+
+\item \texttt{package\_convergence\_filename}---name of the comma spaced values output file to write package convergence information.
+
 \item \texttt{TS6}---keyword to specify that record corresponds to a time-series file.
 
 \item \texttt{FILEIN}---keyword to specify that an input filename is expected next.

doc/mf6io/mf6ivar/tex/gwf-uzf-options.dat

@@ -6,6 +6,7 @@ BEGIN OPTIONS
   [PRINT_FLOWS]
   [SAVE_FLOWS]
   [BUDGET FILEOUT <budgetfile>]
+  [PACKAGE_CONVERGENCE FILEOUT <package_convergence_filename>]
   [TS6 FILEIN <ts6_filename>]
   [OBS6 FILEIN <obs6_filename>]
   [MOVER]