Issue #746 slice model transport (#781)

luitjansl · web-flow · commit 9a4b7112d996 · 2024-01-29T17:16:25.000Z
Fixes #746 # Description Fixes the slice_model function to slice transport models as well. Includes changes to the Advection package. The advection scheme parameter is set by the constructors of derived types of advection. Trying to reinitialize the derived type throws an error, as its construction method doesn't expect arguments. As a pragmatic solution, the constructor methods now get a ``**ignored`` argument to ignore these kwargs. - [x] Links to correct issue - [ ] Update changelog, if changes affect users - [x] PR title starts with ``Issue #nr``, e.g. ``Issue #737`` - [x] Unit tests were added - [ ] **If feature added**: Added/extended example
diff --git a/imod/mf6/adv.py b/imod/mf6/adv.py
@@ -8,6 +8,8 @@
 Upstream weighting is a fast alternative, and TVD is a more expensive and more
 robust alternative.
 """
+from copy import deepcopy
+
 from imod.mf6.package import Package
 
 
@@ -23,12 +25,20 @@ def render(self, directory, pkgname, globaltimes, binary):
         scheme = self.dataset["scheme"].item()
         return self._template.render({"scheme": scheme})
 
+    def mask(self, _) -> Package:
+        """
+        The mask method is irrelevant for this package , instead this method
+        retuns a copy of itself.
+        """
+        return deepcopy(self)
+
 
 class AdvectionUpstream(Advection):
     """
     The upstream weighting (first order upwind) scheme sets the concentration
     at the cellface between two adjacent cells equal to the concentration in
     the cell where the flow comes from. It surpresses oscillations.
+    Note: all constructor arguments will be ignored
     """
 
     def __init__(self):
@@ -44,6 +54,7 @@ class AdvectionCentral(Advection):
     grids without equal spacing between connected cells, it is retained here
     for consistency with nomenclature used by other MODFLOW-based transport
     programs, such as MT3D.
+    Note: all constructor arguments will be ignored
     """
 
     def __init__(self):
@@ -54,6 +65,7 @@ class AdvectionTVD(Advection):
     """
     An implicit second order TVD scheme. More expensive than upstream
     weighting but more robust.
+    Note: all constructor arguments will be ignored
     """
 
     def __init__(self):
diff --git a/imod/mf6/multimodel/modelsplitter.py b/imod/mf6/multimodel/modelsplitter.py
@@ -9,7 +9,6 @@
 from imod.mf6.boundary_condition import BoundaryCondition
 from imod.mf6.hfb import HorizontalFlowBarrierBase
 from imod.mf6.model import Modflow6Model
-from imod.mf6.model_gwf import GroundwaterFlowModel
 from imod.mf6.utilities.clip import clip_by_grid
 from imod.mf6.utilities.grid import get_active_domain_slice
 from imod.mf6.wel import Well
@@ -70,7 +69,8 @@ def slice_model(partition_info: PartitionInfo, model: Modflow6Model) -> Modflow6
     that are sliced using the domain_slice. A domain_slice can be created using the
     :func:`imod.mf6.modelsplitter.create_domain_slices` function.
     """
-    new_model = GroundwaterFlowModel(**model._options)
+    modelclass = type(model)
+    new_model = modelclass(**model._options)
     domain_slice2d = get_active_domain_slice(partition_info.active_domain)
     if is_unstructured(model.domain):
         new_idomain = model.domain.sel(domain_slice2d)
diff --git a/imod/tests/test_mf6/test_multimodel/test_mf6_modelsplitter_transport.py b/imod/tests/test_mf6/test_multimodel/test_mf6_modelsplitter_transport.py
@@ -0,0 +1,23 @@
+from imod.mf6.multimodel.modelsplitter import create_partition_info, slice_model
+from imod.typing.grid import zeros_like
+
+
+def test_slice_model_structured(flow_transport_simulation):
+    # Arrange.
+    transport_model = flow_transport_simulation["tpt_a"]
+    submodel_labels = zeros_like(transport_model.domain)
+    submodel_labels[:, :, 30:] = 1
+
+    partition_info = create_partition_info(submodel_labels)
+
+    submodel_list = []
+
+    # Act
+    for submodel_partition_info in partition_info:
+        submodel_list.append(slice_model(submodel_partition_info, transport_model))
+
+    # Assert
+    assert len(submodel_list) == 2
+    for submodel in submodel_list:
+        for package_name in list(transport_model.keys()):
+            assert package_name in list(submodel.keys())
