refactor: BaseStructuredSupport extends StructuredGrid3DGeometry

packages/loop_common/src/loop_common/geometry/_bounding_box.py

@@ -8,7 +8,6 @@
 
 # from LoopStructural.utils.exceptions import LoopValueError
 from loop_common.math import rng
-from loop_common.supports import StructuredGrid
 
 logger = getLogger(__name__)
 
@@ -701,6 +700,9 @@ def structured_grid(
         name: str = "bounding_box",
         local_coordinates: bool = False,
     ):
+        # imported here because loop_common.supports builds on loop_common.geometry
+        from loop_common.supports import StructuredGrid
+
         # python is passing a reference to the cell_data, vertex_data dicts so we need to
         # copy them to make sure that different instances of StructuredGrid are not sharing the same
         # underlying objects

packages/loop_common/src/loop_common/geometry/_structured_grid_3d.py

@@ -39,6 +39,9 @@ def __init__(self, origin=None, nsteps=None, step_vector=None, rotation_xy=None)
         self._rotation_xy[2, 2] = 1
         self.rotation_xy = rotation_xy
 
+    def _on_geometry_change(self):
+        """Hook called after origin, step_vector, nsteps or maximum change; subclasses override."""
+
     @property
     def volume(self):
         return np.prod(self.maximum - self.origin)
@@ -69,6 +72,7 @@ def nsteps(self, nsteps):
         change_factor = nsteps / self.nsteps
         self._step_vector /= change_factor
         self._nsteps = nsteps
+        self._on_geometry_change()
 
     @property
     def nsteps_cells(self):
@@ -99,6 +103,7 @@ def step_vector(self, step_vector):
         newsteps = self._nsteps / change_factor
         self._nsteps = np.ceil(newsteps).astype(int)
         self._step_vector = step_vector
+        self._on_geometry_change()
 
     @property
     def origin(self):
@@ -115,6 +120,7 @@ def origin(self, origin):
             logger.error(f"Cannot resize the grid. The proposed number of steps is {self._nsteps}, these must be all > 0")
             raise ValueError("Cannot resize the grid.")
         self._origin = origin
+        self._on_geometry_change()
 
     @property
     def maximum(self):
@@ -130,6 +136,7 @@ def maximum(self, maximum):
         if np.any(~(self._nsteps > 0)):
             logger.error(f"Cannot resize the grid. The proposed number of steps is {self._nsteps}, these must be all > 0")
             raise ValueError("Cannot resize the grid.")
+        self._on_geometry_change()
 
     @property
     def n_nodes(self):
@@ -211,27 +218,6 @@ def check_position(self, pos: np.ndarray) -> np.ndarray:
             raise ValueError("Position array needs to be a list of points or a point")
         return pos
 
-    def neighbour_global_indexes(self, mask=None, **kwargs):
-        indexes = None
-        if "indexes" in kwargs:
-            indexes = kwargs["indexes"]
-        if "indexes" not in kwargs:
-            gi = np.arange(self.n_nodes)
-            indexes = self.global_index_to_node_index(gi)
-            edge_mask = (
-                (indexes[:, 0] > 0) & (indexes[:, 0] < self.nsteps[0] - 1)
-                & (indexes[:, 1] > 0) & (indexes[:, 1] < self.nsteps[1] - 1)
-                & (indexes[:, 2] > 0) & (indexes[:, 2] < self.nsteps[2] - 1)
-            )
-            indexes = indexes[edge_mask, :].T
-        if indexes.ndim != 2:
-            logger.error("indexes.ndim = %s, expected 2", indexes.ndim)
-            return
-        if mask is None:
-            mask = np.array([[-1, 0, 1, -1, 0, 1, -1, 0, 1], [1, 1, 1, 0, 0, 0, -1, -1, -1]])
-        neighbours = indexes[:, None, :] + mask[:, :, None]
-        return (neighbours[0, :, :] + self.nsteps[0, None, None] * neighbours[1, :, :]).astype(np.int64)
-
     def cell_corner_indexes(self, cell_indexes: np.ndarray) -> np.ndarray:
         corner_indexes = np.zeros((cell_indexes.shape[0], 8, 3), dtype=np.int64)
         xcorner = np.array([0, 1, 0, 1, 0, 1, 0, 1])