fix: adding a factory method to create an interpolator

Author: lachlangrose

LoopStructural/interpolators/_interpolator_factory.py

@@ -0,0 +1,81 @@
+from typing import Optional
+
+from . import interpolator_map, InterpolatorType, support_interpolator_map
+from LoopStructural.utils import BoundingBox
+from typing import Optional
+import numpy as np
+
+from ..interpolators.supports import SupportFactory
+
+
+class InterpolatorFactory:
+    @staticmethod
+    def create_interpolator(
+        interpolatortype: str,
+        boundingbox: BoundingBox,
+        nelements: int,
+        element_volume: Optional[float] = None,
+        support=None,
+    ):
+        if interpolatortype == None:
+            raise ValueError("No interpolator type specified")
+        if boundingbox == None:
+            raise ValueError("No bounding box specified")
+        if nelements == None:
+            raise ValueError("No number of elements specified")
+        if type(interpolatortype) == str:
+            interpolatortype = InterpolatorType._member_map_[interpolatortype].numerator
+        if support is None:
+            supporttype = support_interpolator_map[interpolatortype]
+            support = SupportFactory.create_support_from_bbox(
+                supporttype,
+                bounding_box=boundingbox,
+                nelements=nelements,
+                element_volume=element_volume,
+            )   
+        return interpolator_map[interpolatortype](support)
+ 
+    @staticmethod
+    def from_dict(d):
+        d = d.copy()
+        interpolator_type = d.pop("type", None)
+        if interpolator_type is None:
+            raise ValueError("No interpolator type specified")
+        return InterpolatorFactory.create_interpolator(interpolator_type, **d)
+
+    @staticmethod
+    def get_supported_interpolators():
+        return interpolator_map.keys()
+
+    @staticmethod
+    def create_interpolator_with_data(
+        interpolatortype: str,
+        boundingbox: BoundingBox,
+        nelements: int,
+        element_volume: Optional[float] = None,
+        support=None,
+        value_constraints: Optional[np.ndarray] = None,
+        gradient_norm_constraints: Optional[np.ndarray] = None,
+        gradient_constraints: Optional[np.ndarray] = None,
+    ):
+        if interpolatortype == None:
+            raise ValueError("No interpolator type specified")
+        if boundingbox == None:
+            raise ValueError("No bounding box specified")
+        if nelements == None:
+            raise ValueError("No number of elements specified")
+        if type(interpolatortype) == str:
+            interpolatortype = InterpolatorType._member_map_[interpolatortype].numerator
+        if support is None:
+            supporttype = support_interpolator_map[interpolatortype]
+            support = SupportFactory.create_support(
+                supporttype, boundingbox, nelements, element_volume
+            )
+        interpolator = interpolator_map[interpolatortype](support)
+        if value_constraints is not None:
+            interpolator.add_value_constraints(value_constraints)
+        if gradient_norm_constraints is not None:
+            interpolator.add_gradient_constraints(gradient_norm_constraints)
+        if gradient_constraints is not None:
+            interpolator.add_gradient_constraints(gradient_constraints)
+        return interpolator