Merge pull request #161 from MiraGeoscience/GEOPY-1729

domfournier · web-flow · commit 82f980187b85 · 2025-03-05T10:07:03.000-08:00
GEOPY-1729: Add option for MUMPS solver
diff --git a/simpeg_drivers-assets/uijson/direct_current_2d_forward.ui.json b/simpeg_drivers-assets/uijson/direct_current_2d_forward.ui.json
@@ -217,6 +217,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "max_chunk_size": {
         "min": 0,
diff --git a/simpeg_drivers-assets/uijson/direct_current_2d_inversion.ui.json b/simpeg_drivers-assets/uijson/direct_current_2d_inversion.ui.json
@@ -546,6 +546,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "store_sensitivities": {
         "choiceList": [
diff --git a/simpeg_drivers-assets/uijson/direct_current_3d_forward.ui.json b/simpeg_drivers-assets/uijson/direct_current_3d_forward.ui.json
@@ -122,6 +122,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/direct_current_3d_inversion.ui.json b/simpeg_drivers-assets/uijson/direct_current_3d_inversion.ui.json
@@ -494,6 +494,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/direct_current_batch2d_forward.ui.json b/simpeg_drivers-assets/uijson/direct_current_batch2d_forward.ui.json
@@ -175,6 +175,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "max_chunk_size": {
         "min": 0,
diff --git a/simpeg_drivers-assets/uijson/direct_current_batch2d_inversion.ui.json b/simpeg_drivers-assets/uijson/direct_current_batch2d_inversion.ui.json
@@ -503,6 +503,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "store_sensitivities": {
         "choiceList": [
diff --git a/simpeg_drivers-assets/uijson/fem_forward.ui.json b/simpeg_drivers-assets/uijson/fem_forward.ui.json
@@ -135,6 +135,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/fem_inversion.ui.json b/simpeg_drivers-assets/uijson/fem_inversion.ui.json
@@ -530,6 +530,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_2d_forward.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_2d_forward.ui.json
@@ -228,6 +228,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "max_chunk_size": {
         "min": 0,
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_2d_inversion.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_2d_inversion.ui.json
@@ -556,6 +556,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "max_ram": "",
     "store_sensitivities": {
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_3d_forward.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_3d_forward.ui.json
@@ -162,6 +162,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_3d_inversion.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_3d_inversion.ui.json
@@ -534,6 +534,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_batch2d_forward.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_batch2d_forward.ui.json
@@ -212,6 +212,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "max_chunk_size": {
         "min": 0,
diff --git a/simpeg_drivers-assets/uijson/induced_polarization_batch2d_inversion.ui.json b/simpeg_drivers-assets/uijson/induced_polarization_batch2d_inversion.ui.json
@@ -540,6 +540,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": 1,
     "store_sensitivities": {
         "choiceList": [
diff --git a/simpeg_drivers-assets/uijson/magnetotellurics_forward.ui.json b/simpeg_drivers-assets/uijson/magnetotellurics_forward.ui.json
@@ -202,6 +202,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/magnetotellurics_inversion.ui.json b/simpeg_drivers-assets/uijson/magnetotellurics_inversion.ui.json
@@ -741,6 +741,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/tdem_forward.ui.json b/simpeg_drivers-assets/uijson/tdem_forward.ui.json
@@ -154,6 +154,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/tdem_inversion.ui.json b/simpeg_drivers-assets/uijson/tdem_inversion.ui.json
@@ -567,6 +567,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/tipper_forward.ui.json b/simpeg_drivers-assets/uijson/tipper_forward.ui.json
@@ -178,6 +178,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers-assets/uijson/tipper_inversion.ui.json b/simpeg_drivers-assets/uijson/tipper_inversion.ui.json
@@ -621,6 +621,16 @@
         "value": 1,
         "visible": false
     },
+    "solver_type": {
+        "choiceList": [
+            "Pardiso",
+            "Mumps"
+        ],
+        "group": "Compute",
+        "label": "Direct solver",
+        "tooltip": "Direct solver to use for the forward calculations",
+        "value": "Pardiso"
+    },
     "tile_spatial": {
         "group": "Compute",
         "label": "Number of tiles",
diff --git a/simpeg_drivers/components/factories/simulation_factory.py b/simpeg_drivers/components/factories/simulation_factory.py
@@ -53,7 +53,7 @@ def __init__(self, params: BaseParams | BaseOptions):
         ]:
             import pymatsolver.direct as solver_module
 
-            self.solver = solver_module.Pardiso
+            self.solver = getattr(solver_module, params.solver_type)
 
     def concrete_object(self):
         if self.factory_type in ["magnetic scalar", "magnetic vector"]:
diff --git a/simpeg_drivers/params.py b/simpeg_drivers/params.py
@@ -12,6 +12,7 @@
 from __future__ import annotations
 
 import multiprocessing
+from enum import Enum
 from logging import getLogger
 from pathlib import Path
 from typing import ClassVar, TypeAlias
@@ -56,6 +57,15 @@ def at_least_one(cls, data):
         return data
 
 
+class SolverType(str, Enum):
+    """
+    Supported solvers.
+    """
+
+    Pardiso = "Pardiso"
+    Mumps = "Mumps"
+
+
 class CoreOptions(BaseData):
     """
     Core parameters shared by inverse and forward operations.
@@ -94,6 +104,7 @@ class CoreOptions(BaseData):
     mesh: Octree | DrapeModel | None
     starting_model: float | FloatData
     active_cells: ActiveCellsOptions
+    solver_type: SolverType = SolverType.Pardiso
     tile_spatial: int = 1
     parallelized: bool = True
     n_cpu: int | None = None
diff --git a/tests/run_tests/driver_airborne_tem_test.py b/tests/run_tests/driver_airborne_tem_test.py
diff --git a/tests/run_tests/driver_ground_tem_test.py b/tests/run_tests/driver_ground_tem_test.py
