fix: ✨ adding support type enum

Author: lachlangrose

LoopStructural/interpolators/supports/_2d_base_unstructured.py

@@ -5,13 +5,16 @@
 
 import numpy as np
 
+from . import SupportType
+
 logger = logging.getLogger(__name__)
 
 
 class BaseUnstructured2d:
     """ """
 
     def __init__(self, elements, vertices, neighbours):
+        self.type = SupportType.BaseUnstructured2d
         self.elements = elements
         self.vertices = vertices
         if self.elements.shape[1] == 3:
@@ -23,7 +26,6 @@ def __init__(self, elements, vertices, neighbours):
         self.n_nodes = self.nx
         self.neighbours = neighbours
 
-        self.properties = {}
         # build an array of edges and edge relationships
         self.edges = np.zeros((self.nelements * 3, 2), dtype=int)
         self.edge_relationships = np.zeros((self.nelements * 3, 2), dtype=int)
@@ -94,7 +96,7 @@ def element_area(self, elements):
         area = np.abs(np.linalg.det(M_t)) * 0.5
         return area
 
-    def evaluate_value(self, pos, prop):
+    def evaluate_value(self, pos, values):
         """
         Evaluate value of interpolant
 
@@ -115,7 +117,7 @@ def evaluate_value(self, pos, prop):
         inside = tri >= 0
         # vertices, c, elements, inside = self.get_elements_for_location(pos)
         values[inside] = np.sum(
-            c[inside, :] * self.properties[prop][self.elements[tri[inside], :]], axis=1
+            c[inside, :] * values[self.elements[tri[inside], :]], axis=1
         )
         return values
 

LoopStructural/interpolators/supports/_2d_p1_unstructured.py

@@ -5,6 +5,7 @@
 
 import numpy as np
 from ._2d_base_unstructured import BaseUnstructured2d
+from . import SupportType
 
 logger = logging.getLogger(__name__)
 
@@ -14,6 +15,7 @@ class P1Unstructured2d(BaseUnstructured2d):
 
     def __init__(self, elements, vertices, neighbours):
         BaseUnstructured2d.__init__(self, elements, vertices, neighbours)
+        self.type = SupportType.P1Unstructured2d
 
     def evaluate_shape_derivatives(self, locations, elements=None):
         """

LoopStructural/interpolators/supports/_2d_p2_unstructured.py

@@ -2,9 +2,11 @@
 Tetmesh based on cartesian grid for piecewise linear interpolation
 """
 import logging
+from re import S
 
 import numpy as np
 from ._2d_base_unstructured import BaseUnstructured2d
+from . import SupportType
 
 logger = logging.getLogger(__name__)
 
@@ -14,6 +16,7 @@ class P2Unstructured2d(BaseUnstructured2d):
 
     def __init__(self, elements, vertices, neighbours):
         BaseUnstructured2d.__init__(self, elements, vertices, neighbours)
+        self.type = SupportType.P2Unstructured2d
         # hessian of shape functions
         self.H = np.array(
             [
@@ -271,7 +274,6 @@ def evaluate_d2(self, pos, prop):
 
     def get_quadrature_points(self, npts=2):
         if npts == 2:
-
             v1 = self.nodes[self.edges][:, 0, :]
             v2 = self.nodes[self.edges][:, 1, :]
             cp = np.zeros((v1.shape[0], self.ncps, 2))

LoopStructural/interpolators/supports/_2d_structured_grid.py

@@ -5,6 +5,7 @@
 import logging
 
 import numpy as np
+from . import SupportType
 
 logger = logging.getLogger(__name__)
 
@@ -26,7 +27,7 @@ def __init__(
         nsteps - 2d list or numpy array of ints
         step_vector - 2d list or numpy array of int
         """
-
+        self.type = SupportType.StructuredGrid2D
         self.nsteps = np.array(nsteps)
         self.step_vector = np.array(step_vector)
         self.origin = np.array(origin)
@@ -74,23 +75,6 @@ def print_geometry(self):
         max = self.origin + self.nsteps_cells * self.step_vector
         print("Max extent: %f %f %f" % (max[0], max[1], max[2]))
 
-    def update_property(self, propertyname, values):
-        """[summary]
-
-        [extended_summary]
-
-        Parameters
-        ----------
-        propertyname : [type]
-            [description]
-        values : [type]
-            [description]
-        """
-        if values.shape[0] == self.n_nodes:
-            self.properties[propertyname] = values
-        if values.shape[0] == self.n_elements:
-            self.cell_properties[propertyname] = values
-
     def cell_centres(self, global_index):
         """[summary]
 
@@ -144,7 +128,6 @@ def position_to_cell_index(self, pos):
         return ix.astype(int), iy.astype(int)
 
     def inside(self, pos):
-
         # check whether point is inside box
         inside = np.ones(pos.shape[0]).astype(bool)
         for i in range(self.dim):
@@ -330,14 +313,12 @@ def global_index_to_cell_index(self, global_index):
         return x_index, y_index
 
     def node_indexes_to_position(self, xindex, yindex):
-
         x = self.origin[0] + self.step_vector[0] * xindex
         y = self.origin[1] + self.step_vector[1] * yindex
 
         return x, y
 
     def position_to_cell_corners(self, pos):
-
         inside = self.inside(pos)
         ix, iy = self.position_to_cell_index(pos)
         cornersx, cornersy = self.cell_corner_indexes(ix, iy)

LoopStructural/interpolators/supports/_3d_base_structured.py

@@ -1,5 +1,6 @@
 import numpy as np
 from LoopStructural.utils import getLogger
+from . import SupportType
 
 logger = getLogger(__name__)
 
@@ -27,6 +28,7 @@ def __init__(
         # we use property decorators to update these when different parts of
         # the geometry need to change
         # inisialise the private attributes
+        self.type = SupportType.BaseStructured
         if np.any(step_vector == 0):
             logger.warning(f"Step vector {step_vector} has zero values")
         self._nsteps = np.array(nsteps, dtype=int) + 1
@@ -39,6 +41,14 @@ def __init__(
         self._rotation_xy[2, 2] = 1
         self.rotation_xy = rotation_xy
 
+    def to_dict(self):
+        return {
+            "origin": self.origin,
+            "nsteps": self.nsteps,
+            "step_vector": self.step_vector,
+            "rotation_xy": self.rotation_xy,
+        }
+
     @property
     def nsteps(self):
         return self._nsteps
@@ -60,13 +70,30 @@ def rotation_xy(self):
 
     @rotation_xy.setter
     def rotation_xy(self, rotation_xy):
-        if rotation_xy is not None:
-            self._rotation_xy[:, :] = 0
-            self._rotation_xy[0, 0] = np.cos(np.deg2rad(rotation_xy))
-            self._rotation_xy[0, 1] = -np.sin(np.deg2rad(rotation_xy))
-            self._rotation_xy[1, 0] = np.sin(np.deg2rad(rotation_xy))
-            self._rotation_xy[1, 1] = np.cos(np.deg2rad(rotation_xy))
-            self._rotation_xy[2, 2] = 1.0  # make sure rotation around z vector
+        if rotation_xy is None:
+            return
+        if isinstance(rotation_xy, (float, int)):
+            rotation_xy = np.array(
+                [
+                    [
+                        np.cos(np.deg2rad(rotation_xy)),
+                        -np.sin(np.deg2rad(rotation_xy)),
+                        0,
+                    ],
+                    [
+                        np.sin(np.deg2rad(rotation_xy)),
+                        np.cos(np.deg2rad(rotation_xy)),
+                        0,
+                    ],
+                    [0, 0, 1],
+                ]
+            )
+        rotation_xy = np.array(rotation_xy)
+        if rotation_xy.shape != (3, 3):
+            raise ValueError(
+                "Rotation matrix should be 3x3, not {}".format(rotation_xy.shape)
+            )
+        self._rotation_xy = rotation_xy
 
     @property
     def step_vector(self):
@@ -304,7 +331,6 @@ def cell_corner_indexes(self, cell_indexes):
         return corner_indexes
 
     def position_to_cell_corners(self, pos):
-
         inside = self.inside(pos)
 
         cell_indexes = self.position_to_cell_index(pos)

LoopStructural/interpolators/supports/_3d_p2_tetra.py

@@ -1,6 +1,7 @@
 from ._3d_unstructured_tetra import UnStructuredTetMesh
 
 import numpy as np
+from . import SupportType
 
 
 class P2UnstructuredTetMesh(UnStructuredTetMesh):
@@ -12,6 +13,7 @@ def __init__(
         aabb_nsteps=None,
     ):
         UnStructuredTetMesh.__init__(self, nodes, elements, neighbours, aabb_nsteps)
+        self.type = SupportType.P2UnstructuredTetMesh
         if self.elements.shape[1] != 10:
             raise ValueError(
                 f"P2 tetrahedron must have 8 nodes, has {self.elements.shape[1]}"

LoopStructural/interpolators/supports/_3d_structured_grid.py

@@ -8,6 +8,7 @@
 
 from ._3d_base_structured import BaseStructuredSupport
 
+from . import SupportType
 
 from LoopStructural.utils import getLogger
 
@@ -22,7 +23,7 @@ def __init__(
         origin=np.zeros(3),
         nsteps=np.array([10, 10, 10]),
         step_vector=np.ones(3),
-        name=None,
+        rotation_xy=None,
     ):
         """
 
@@ -32,10 +33,12 @@ def __init__(
         nsteps - 3d list or numpy array of ints
         step_vector - 3d list or numpy array of int
         """
-        BaseStructuredSupport.__init__(self, origin, nsteps, step_vector)
+        BaseStructuredSupport.__init__(
+            self, origin, nsteps, step_vector, rotation_xy=rotation_xy
+        )
+        self.type = SupportType.StructuredGrid
         self.regions = {}
         self.regions["everywhere"] = np.ones(self.n_nodes).astype(bool)
-        self.name = name
 
     @property
     def barycentre(self):
@@ -475,3 +478,9 @@ def get_element_for_location(self, pos):
 
     def get_elements(self):
         return
+
+    def to_dict(self):
+        return {
+            "type": self.type.numerator,
+            **super().to_dict(),
+        }

LoopStructural/interpolators/supports/_3d_structured_tetra.py

@@ -5,6 +5,7 @@
 
 import numpy as np
 from ._3d_base_structured import BaseStructuredSupport
+from . import SupportType
 
 from LoopStructural.utils import getLogger
 
@@ -18,7 +19,7 @@ def __init__(
         self, origin=np.zeros(3), nsteps=np.ones(3) * 10, step_vector=np.ones(3)
     ):
         BaseStructuredSupport.__init__(self, origin, nsteps, step_vector)
-
+        self.type = SupportType.TetMesh
         self.tetra_mask_even = np.array(
             [[7, 1, 2, 4], [6, 2, 4, 7], [5, 1, 4, 7], [0, 1, 2, 4], [3, 1, 2, 7]]
         )
@@ -115,7 +116,6 @@ def evaluate_gradient(
         return values
 
     def inside(self, pos: np.ndarray):
-
         inside = np.ones(pos.shape[0]).astype(bool)
         for i in range(3):
             inside *= pos[:, i] > self.origin[None, i]

LoopStructural/interpolators/supports/_3d_unstructured_tetra.py

@@ -8,6 +8,7 @@
 
 from ._3d_base_structured import BaseStructuredSupport
 from LoopStructural.utils import getLogger
+from . import SupportType
 
 logger = getLogger(__name__)
 
@@ -39,6 +40,7 @@ def __init__(
         aabb_nsteps : list, optional
             force nsteps for aabb, by default None
         """
+        self.type = SupportType.UnStructuredTetMesh
         self.nodes = np.array(nodes)
         if self.nodes.shape[1] != 3:
             raise ValueError("Nodes must be 3D")
@@ -395,7 +397,6 @@ def get_element_for_location(self, points):
         npts_step = int(1e4)
         # break into blocks of 10k points
         while npts < points.shape[0]:
-
             cell_index = np.array(
                 self.aabb_grid.position_to_cell_index(points[: npts + npts_step, :])
             )

LoopStructural/interpolators/supports/__init__.py

@@ -1,3 +1,25 @@
+from enum import IntEnum
+
+
+class SupportType(IntEnum):
+    """
+    Enum for the different interpolator types
+
+    1-9 should cover interpolators with supports
+    9+ are data supported
+    """
+
+    StructuredGrid2D = 0
+    StructuredGrid = 1
+    UnStructuredTetMesh = 2
+    P1Unstructured2d = 3
+    P2Unstructured2d = 4
+    BaseUnstructured2d = 5
+    BaseStructured = 6
+    TetMesh = 10
+    P2UnstructuredTetMesh = 11
+
+
 from ._2d_base_unstructured import BaseUnstructured2d
 from ._2d_p1_unstructured import P1Unstructured2d
 from ._2d_p2_unstructured import P2Unstructured2d
@@ -6,3 +28,26 @@
 from ._3d_unstructured_tetra import UnStructuredTetMesh
 from ._3d_structured_tetra import TetMesh
 from ._3d_p2_tetra import P2UnstructuredTetMesh
+
+support_map = {
+    SupportType.StructuredGrid2D: StructuredGrid2D,
+    SupportType.StructuredGrid: StructuredGrid,
+    SupportType.UnStructuredTetMesh: UnStructuredTetMesh,
+    SupportType.P1Unstructured2d: P1Unstructured2d,
+    SupportType.P2Unstructured2d: P2Unstructured2d,
+    SupportType.TetMesh: TetMesh,
+    SupportType.P2UnstructuredTetMesh: P2UnstructuredTetMesh,
+}
+
+__all__ = [
+    "BaseUnstructured2d",
+    "P1Unstructured2d",
+    "P2Unstructured2d",
+    "StructuredGrid2D",
+    "StructuredGrid",
+    "UnStructuredTetMesh",
+    "TetMesh",
+    "P2UnstructuredTetMesh",
+    "support_map",
+    "SupportType",
+]