refactor(NumericalSolution): refactor csv output (#395)

* refactor(NumericalSolution): refactor csv output Refactor csv output to save at the end of the each outer iteration. Add options to save separate outer and inner iteration data. closes #172
MODFLOW-USGS · Apr 10, 2020 · 2c40af8 · 2c40af8
1 parent c173833
commit 2c40af8
Show file tree

Hide file tree

Showing 11 changed files with 248 additions and 138 deletions.
diff --git a/autotest/test_gwf_mvr01.py b/autotest/test_gwf_mvr01.py
@@ -57,7 +57,12 @@ def get_model(idx, dir):
                                save_flows=True, print_flows=True)
 
     # create iterative model solution and register the gwf model with it
-    ims = flopy.mf6.ModflowIms(sim, print_option='SUMMARY',
+    csv0 = '{}.outer.ims.csv'.format(name)
+    csv1 = '{}.inner.ims.csv'.format(name)
+    ims = flopy.mf6.ModflowIms(sim,
+                               csv_outer_output_filerecord=csv0,
+                               csv_inner_output_filerecord=csv1,
+                               print_option='SUMMARY',
                                outer_hclose=hclose,
                                outer_maximum=nouter,
                                under_relaxation='NONE',

diff --git a/autotest/test_gwf_npf02_rewet.py b/autotest/test_gwf_npf02_rewet.py
@@ -98,9 +98,15 @@ def get_model(idx, dir):
     # create tdis package
     tdis = flopy.mf6.ModflowTdis(sim, time_units='DAYS',
                                  nper=nper, perioddata=tdis_rc)
+    # set ims csv files
+    csv0 = '{}.outer.ims.csv'.format(name)
+    csv1 = '{}.inner.ims.csv'.format(name)
 
     # create iterative model solution and register the gwf model with it
-    ims = flopy.mf6.ModflowIms(sim, print_option='SUMMARY',
+    ims = flopy.mf6.ModflowIms(sim,
+                               print_option='ALL',
+                               csv_outer_output_filerecord=csv0,
+                               csv_inner_output_filerecord=csv1,
                                outer_hclose=hclose,
                                outer_maximum=nouter,
                                under_relaxation='NONE',
@@ -197,9 +203,9 @@ def build_models():
 
 def eval_hds(sim):
     print('evaluating rewet heads...')
-    
+
     hdata01lay = [[1.000000000000000000e+02, 9.491194675652451451e+01,
-                   8.963852784804279850e+01, 8.415783779990768210e+01, 
+                   8.963852784804279850e+01, 8.415783779990768210e+01,
                    7.844327192271720151e+01, 7.246197081412121577e+01,
                    6.617253666303386694e+01, 5.952154998933371388e+01,
                    5.243800267025346074e+01, 4.482387942676999870e+01,

diff --git a/autotest/test_gwf_rch01.py b/autotest/test_gwf_rch01.py
@@ -69,11 +69,15 @@ def get_model(idx, dir):
     tdis = flopy.mf6.ModflowTdis(sim, time_units='DAYS',
                                  nper=nper, perioddata=tdis_rc)
 
-    # create gwf model
-    gwf = flopy.mf6.ModflowGwf(sim, modelname=name, save_flows=True)
+    # set ims csv files
+    csv0 = '{}.outer.ims.csv'.format(name)
+    csv1 = '{}.inner.ims.csv'.format(name)
 
     # create iterative model solution and register the gwf model with it
-    ims = flopy.mf6.ModflowIms(sim, print_option='SUMMARY',
+    ims = flopy.mf6.ModflowIms(sim,
+                               print_option='ALL',
+                               csv_outer_output_filerecord=csv0,
+                               csv_inner_output_filerecord=csv1,
                                outer_hclose=hclose,
                                outer_maximum=nouter,
                                under_relaxation='DBD',
@@ -83,7 +87,9 @@ def get_model(idx, dir):
                                scaling_method='NONE',
                                reordering_method='NONE',
                                relaxation_factor=relax)
-    sim.register_ims_package(ims, [gwf.name])
+
+    # create gwf model
+    gwf = flopy.mf6.ModflowGwf(sim, modelname=name, save_flows=True)
 
     dis = flopy.mf6.ModflowGwfdis(gwf, nlay=nlay, nrow=nrow, ncol=ncol,
                                   delr=delr, delc=delc,

diff --git a/doc/mf6io/mf6ivar/dfn/sln-ims.dfn b/doc/mf6io/mf6ivar/dfn/sln-ims.dfn
@@ -17,8 +17,8 @@ longname print option
 description is an optional keyword that defines default non-linear and linear solver parameters.  SIMPLE - indicates that default solver input values will be defined that work well for nearly linear models. This would be used for models that do not include nonlinear stress packages and models that are either confined or consist of a single unconfined layer that is thick enough to contain the water table within a single layer. MODERATE - indicates that default solver input values will be defined that work well for moderately nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers. The MODERATE option should be used when the SIMPLE option does not result in successful convergence.  COMPLEX - indicates that default solver input values will be defined that work well for highly nonlinear models. This would be used for models that include nonlinear stress packages and models that consist of one or more unconfined layers representing complex geology and surface-water/groundwater interaction. The COMPLEX option should be used when the MODERATE option does not result in successful convergence.  Non-linear and linear solver parameters assigned using a specified complexity can be modified in the NONLINEAR and LINEAR blocks. If the COMPLEXITY option is not specified, NONLINEAR and LINEAR variables will be assigned the simple complexity values.
 
 block options
-name csv_output_filerecord
-type record csv_output fileout csvfile
+name csv_outer_output_filerecord
+type record csv_outer_output fileout outer_csvfile
 shape
 reader urword
 tagged true
@@ -27,15 +27,15 @@ longname
 description
 
 block options
-name csv_output
+name csv_outer_output
 type keyword
 shape
 in_record true
 reader urword
 tagged true
 optional false
 longname budget keyword
-description keyword to specify that the record corresponds to the comma separated values solver convergence output.
+description keyword to specify that the record corresponds to the comma separated values outer iteration convergence output.
 
 block options
 name fileout
@@ -49,7 +49,40 @@ longname file keyword
 description keyword to specify that an output filename is expected next.
 
 block options
-name csvfile
+name outer_csvfile
+type string
+preserve_case true
+shape
+in_record true
+reader urword
+tagged false
+optional false
+longname file keyword
+description name of the ascii comma separated values output file to write maximum head change convergence information at the end of each outer iteration for each time step.
+
+block options
+name csv_inner_output_filerecord
+type record csv_inner_output fileout inner_csvfile
+shape
+reader urword
+tagged true
+optional true
+longname
+description
+
+block options
+name csv_inner_output
+type keyword
+shape
+in_record true
+reader urword
+tagged true
+optional false
+longname budget keyword
+description keyword to specify that the record corresponds to the comma separated values solver convergence output.
+
+block options
+name inner_csvfile
 type string
 preserve_case true
 shape
@@ -58,7 +91,7 @@ reader urword
 tagged false
 optional false
 longname file keyword
-description name of the ascii comma separated values output file to write solver convergence information. If PRINT\_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT\_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.
+description name of the ascii comma separated values output file to write solver convergence information. Comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration.
 
 block options
 name no_ptcrecord