feat(solvers): support for multiple solver types (#1706) (#1709)

* fix(exe path): FloPy now correctly resolves relative paths to mf6 executable (#1633) * feat(solvers): support for multiple solver types #1706 * Revert "fix(exe path): FloPy now correctly resolves relative paths to mf6 executable (#1633)" This reverts commit 14335cf. * Update mfsimulation.py feat(solver support): rolling back ims deprecation warning --------- Co-authored-by: scottrp <[email protected]>
modflowpy · Feb 15, 2023 · ea04e83 · ea04e83
1 parent 82a1c0c
commit ea04e83
Show file tree

Hide file tree

Showing 8 changed files with 246 additions and 121 deletions.
diff --git a/autotest/regression/test_mf6.py b/autotest/regression/test_mf6.py
@@ -1697,7 +1697,7 @@ def test005_create_tests_advgw_tidal(function_tmpdir, example_data_path):
             assert filename == f"all_files_same_name.{package.package_type}"
             package_type_dict[package.package_type] = 1
     assert sim._tdis_file.filename == "all_files_same_name.tdis"
-    for ims_file in sim._ims_files.values():
+    for ims_file in sim._solution_files.values():
         assert ims_file.filename == "all_files_same_name.ims"
     sim.write_simulation()
     name_file = str(function_tmpdir / "all_files_same_name.nam")
@@ -3929,12 +3929,12 @@ def test006_2models_mvr(function_tmpdir, example_data_path):
     for name in names:
         assert name in model_names
         model = sim.get_model(name)
-        assert model.model_type == "gwf"
+        assert model.model_type == "gwf6"
     models = sim.gwf
     assert len(models) == 2
     for model in models:
         assert model.name in model_names
-        assert model.model_type == "gwf"
+        assert model.model_type == "gwf6"
 
     # change some settings
     parent_model = sim.get_model(model_names[0])
@@ -4021,7 +4021,7 @@ def test006_2models_mvr(function_tmpdir, example_data_path):
         assert (len(sim._exchange_files) > 0) == (
             "gwf6-gwf6" in load_only or "gwf-gwf" in load_only
         )
-        assert (len(sim._ims_files) > 0) == (
+        assert (len(sim._solution_files) > 0) == (
             "ims6" in load_only or "ims" in load_only
         )
 

diff --git a/flopy/mf6/data/dfn/sln-ims.dfn b/flopy/mf6/data/dfn/sln-ims.dfn
@@ -1,4 +1,5 @@
 # --------------------- sln ims options ---------------------
+# flopy solution_package ims *
 
 block options
 name print_option

diff --git a/flopy/mf6/data/mfstructure.py b/flopy/mf6/data/mfstructure.py
@@ -6,6 +6,7 @@
 import ast
 import keyword
 import os
+import warnings
 from enum import Enum
 from textwrap import TextWrapper
 
@@ -2473,6 +2474,9 @@ def __load_structure(self):
         # set up structure classes
         self.sim_struct = MFSimulationStructure()
 
+        # initialize flopy dict keys
+        MFStructure().flopy_dict["solution_packages"] = {}
+
         if self.load_from_dfn_files:
             mf_dfn = Dfn()
             dfn_files = mf_dfn.get_file_list()
@@ -2503,14 +2507,37 @@ def __load_structure(self):
                                     "parameter_name": line_lst[6],
                                 }
                                 MFStructure().flopy_dict[line_lst[3]] = sp_dict
-
+                            elif line_lst[2] == "solution_package":
+                                MFStructure().flopy_dict["solution_packages"][
+                                    line_lst[3]
+                                ] = line_lst[4:]
+            if len(MFStructure().flopy_dict["solution_packages"]) == 0:
+                MFStructure().flopy_dict["solution_packages"]["ims"] = ["*"]
+                warnings.warn(
+                    "Package definition files (dfn) do not define a solution "
+                    "package.  This can happen if your dfn files are out of "
+                    "sync.  Auto-loaded default IMS solution package metadata."
+                    "  In the future auto-loading default metadata will be "
+                    "deprecated.",
+                    DeprecationWarning,
+                )
             # process each file
             for file in dfn_files:
                 self.sim_struct.process_dfn(DfnFile(file))
             self.sim_struct.tag_read_as_arrays()
         else:
             package_list = PackageContainer.package_list()
             for package in package_list:
+                # process header
+                for entry in package.dfn[0][1:]:
+                    if (
+                        isinstance(entry, list)
+                        and entry[0] == "solution_package"
+                    ):
+                        MFStructure().flopy_dict["solution_packages"][
+                            package.package_abbr
+                        ] = entry[1:]
+                # process each package
                 self.sim_struct.process_dfn(DfnPackage(package))
             self.sim_struct.tag_read_as_arrays()
 

diff --git a/flopy/mf6/modflow/mfgwf.py b/flopy/mf6/modflow/mfgwf.py
@@ -1,6 +1,6 @@
 # DO NOT MODIFY THIS FILE DIRECTLY.  THIS FILE MUST BE CREATED BY
 # mf6/utils/createpackages.py
-# FILE created on December 15, 2022 12:49:36 UTC
+# FILE created on January 27, 2023 18:36:16 UTC
 from .. import mfmodel
 from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator
 
@@ -129,7 +129,7 @@ def load(
             structure,
             modelname,
             model_nam_file,
-            "gwf",
+            "gwf6",
             version,
             exe_name,
             strict,

diff --git a/flopy/mf6/modflow/mfgwt.py b/flopy/mf6/modflow/mfgwt.py
@@ -1,6 +1,6 @@
 # DO NOT MODIFY THIS FILE DIRECTLY.  THIS FILE MUST BE CREATED BY
 # mf6/utils/createpackages.py
-# FILE created on December 15, 2022 12:49:36 UTC
+# FILE created on January 27, 2023 18:36:16 UTC
 from .. import mfmodel
 from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator
 
@@ -122,7 +122,7 @@ def load(
             structure,
             modelname,
             model_nam_file,
-            "gwt",
+            "gwt6",
             version,
             exe_name,
             strict,

diff --git a/flopy/mf6/modflow/mfims.py b/flopy/mf6/modflow/mfims.py
@@ -1,6 +1,6 @@
 # DO NOT MODIFY THIS FILE DIRECTLY.  THIS FILE MUST BE CREATED BY
 # mf6/utils/createpackages.py
-# FILE created on December 15, 2022 12:49:36 UTC
+# FILE created on January 27, 2023 18:36:16 UTC
 from .. import mfpackage
 from ..data.mfdatautil import ListTemplateGenerator
 
@@ -381,6 +381,7 @@ class ModflowIms(mfpackage.MFPackage):
     dfn = [
         [
             "header",
+            ["solution_package", "*"],
         ],
         [
             "block options",