Issue #1696 Optimize modelsplitter (#1693)

Fixes #1696

# Description
This PR implements some of the key insights @Huite found while optimzing
the splitting of Models. Although there are some differences in his
implementation and this PR. The optimizatiob exists of 2 parts

The First part has to do with the way models and packages are split. As
@Huite pointed out the current implementation leads to a package being
loaded and unloaded several times, which leads to a huge performance
penalty because the package needs to be loaded from disk each time.
This has been solved by reverting the order of looping. In the original
implementation there was a loop over the models, foreach partition a
deepcopy was made of the original model. Then afterwards we loop over
each model and access each package in the model to determine if it
belongs to the same domain as the model. This is expensive.
This PR reverts the loop. Frist a shallow copy is made of all the
models. Then we loop over each package of the original package and we
determine if belongs to once of the submodels. This way we only need the
open a package once.

The second part is the way the SSM and BUY packages are updated after
the splitting has happend. There was a pience of code that looped over
all the flow and transport models to determine which models share the
same domain (are in the same partition). This is an expensive operation
because the grid data has to be loaded into memory over and over.
In this PR this has been solved by bringing the update of the SSM and
BUY package to the place where that information is already know i.e. the
model splitter. This way we can avoid the expensive loading of the grid
data.
Also by moving it to the modelsplitter we can avoid forcing the load of
the grid data manually

With these changes the splitting of the mode @Huite provided me takes
now around 5m:30s


# Checklist
<!---
Before requesting review, please go through this checklist:
-->

- [x] Links to correct issue
- [ ] Update changelog, if changes affect users
- [x] PR title starts with ``Issue #nr``, e.g. ``Issue #737``
- [ ] Unit tests were added
- [ ] **If feature added**: Added/extended example
- [ ] **If feature added**: Added feature to API documentation
- [ ] **If pixi.lock was changed**: Ran `pixi run generate-sbom` and
committed changes

---------

Co-authored-by: JoerivanEngelen <joerivanengelen@hotmail.com>

Author: Manangka

docs/api/changelog.rst

@@ -9,6 +9,13 @@ The format is based on `Keep a Changelog`_, and this project adheres to
 [Unreleased]
 ------------
 
+Fixed
+~~~~~
+
+- Improved performance of :meth:`imod.mf6.Modflow6Simulation.split` for large
+  models loaded lazily into memory. Reduced a splitting operation of 2 hours to
+  a few minutes for a test case.
+
 Added
 ~~~~~
 

imod/common/interfaces/iagnosticpackage.py

@@ -0,0 +1,22 @@
+from abc import abstractmethod
+
+from imod.common.interfaces.ipackagebase import IPackageBase
+from imod.typing import GridDataArray
+
+
+class IAgnosticPackage(IPackageBase):
+    """
+    Interface for packages for which the data is defined independent of the domain definition.
+    """
+
+    @abstractmethod
+    def to_mf6_pkg(
+        self,
+        idomain: GridDataArray,
+        top: GridDataArray,
+        bottom: GridDataArray,
+        k: GridDataArray,
+        validate: bool = False,
+        strict_validation: bool = True,
+    ) -> IPackageBase:
+        raise NotImplementedError

imod/common/interfaces/ilinedatapackage.py

@@ -1,13 +1,13 @@
 from abc import abstractmethod
 from typing import TYPE_CHECKING
 
-from imod.common.interfaces.ipackagebase import IPackageBase
+from imod.common.interfaces.iagnosticpackage import IAgnosticPackage
 
 if TYPE_CHECKING:
     import geopandas as gpd
 
 
-class ILineDataPackage(IPackageBase):
+class ILineDataPackage(IAgnosticPackage):
     """
     Interface for packages for which the data is defined by lines independent of the domain definition.
     """

imod/common/interfaces/ipackage.py

@@ -34,3 +34,8 @@ def _is_regridding_supported(self) -> bool:
     @abstractmethod
     def _is_grid_agnostic_package(self) -> bool:
         raise NotImplementedError
+
+    @property
+    @abc.abstractmethod
+    def pkg_id(self) -> str:
+        raise NotImplementedError

imod/common/interfaces/ipointdatapackage.py

@@ -3,10 +3,10 @@
 import numpy as np
 from numpy.typing import NDArray
 
-from imod.common.interfaces.ipackagebase import IPackageBase
+from imod.common.interfaces.iagnosticpackage import IAgnosticPackage
 
 
-class IPointDataPackage(IPackageBase):
+class IPointDataPackage(IAgnosticPackage):
     """
     Interface for packages for which the data is defined by x and y coordinates independent of the domain definition.
     """

imod/mf6/hfb.py

@@ -713,7 +713,7 @@ def to_mf6_pkg(
         bottom: GridDataArray,
         k: GridDataArray,
         validate=True,
-        strict_hfb_validation=True,
+        strict_validation=True,
     ) -> Mf6HorizontalFlowBarrier:
         """
         Write package to Modflow 6 package.
@@ -734,7 +734,7 @@ def to_mf6_pkg(
             Grid with hydraulic conductivities.
         validate: bool
             Validate HorizontalFlowBarrier upon calling this method.
-        strict_hfb_validation: bool
+        strict_validation: bool
             Turn on strict horizontal flow barrier validation.
 
         Returns
@@ -743,7 +743,7 @@ def to_mf6_pkg(
             Low level representation of the HFB package as MODFLOW 6 expects it.
         """
         validation_context = ValidationSettings(
-            validate=validate, strict_hfb_validation=strict_hfb_validation
+            validate=validate, strict_hfb_validation=strict_validation
         )
 
         return self._to_mf6_pkg(idomain, top, bottom, k, validation_context)