fix: moving get interpolator to separate function

Author: lachlangrose

LoopStructural/api/_interpolate.py

@@ -4,6 +4,7 @@
 
 from typing import Optional
 from LoopStructural.interpolators import (
+    GeologicalInterpolator,
     get_interpolator,
 )
 from LoopStructural.utils import BoundingBox
@@ -39,7 +40,9 @@ def __init__(
         """
         self.dimensions = dimensions
         self.type = "FDI"
-        self.interpolator = get_interpolator(bounding_box, type, dimensions, nelements)
+        self.interpolator: GeologicalInterpolator = get_interpolator(
+            bounding_box, type, dimensions, nelements
+        )
 
     def fit(
         self,
@@ -48,6 +51,19 @@ def fit(
         normal_vectors: Optional[np.ndarray] = None,
         inequality_constraints: Optional[np.ndarray] = None,
     ):
+        """_summary_
+
+        Parameters
+        ----------
+        values : Optional[np.ndarray], optional
+            Value constraints for implicit function, by default None
+        tangent_vectors : Optional[np.ndarray], optional
+            tangent constraints for implicit function, by default None
+        normal_vectors : Optional[np.ndarray], optional
+            gradient norm constraints for implicit function, by default None
+        inequality_constraints : Optional[np.ndarray], optional
+            _description_, by default None
+        """
         if values is not None:
             self.interpolator.set_value_constraints(values)
         if tangent_vectors is not None:
@@ -59,11 +75,35 @@ def fit(
 
         self.interpolator.setup()
 
-    def evalute_scalar_value(self, locations: np.ndarray):
+    def evalute_scalar_value(self, locations: np.ndarray) -> np.ndarray:
+        """Evaluate the value of the interpolator at locations
+
+        Parameters
+        ----------
+        locations : np.ndarray
+            Nx3 array of locations to evaluate the interpolator at
+
+        Returns
+        -------
+        np.ndarray
+            value of implicit function at locations
+        """
         self.interpolator.update()
         return self.interpolator.evaluate_value(locations)
 
-    def evaluate_gradient(self, locations: np.ndarray):
+    def evaluate_gradient(self, locations: np.ndarray) -> np.ndarray:
+        """Evaluate the gradient of the interpolator at locations
+
+        Parameters
+        ----------
+        locations : np.ndarray
+            Nx3 locations
+
+        Returns
+        -------
+        np.ndarray
+            Nx3 gradient of implicit function
+        """
         self.interpolator.update()
         return self.interpolator.evaluate_gradient(locations)
 
@@ -81,7 +121,7 @@ def fit_and_evaluate_value(
             normal_vectors=normal_vectors,
             inequality_constraints=inequality_constraints,
         )
-
+        locations = self.interpolator.get_data_locations()
         return self.evalute_scalar_value(locations)
 
     def fit_and_evaluate_gradient(
@@ -97,4 +137,5 @@ def fit_and_evaluate_gradient(
             normal_vectors=normal_vectors,
             inequality_constraints=inequality_constraints,
         )
+        locations = self.interpolator.get_data_locations()
         return self.evaluate_gradient(locations)

LoopStructural/interpolators/_builders.py

@@ -1,3 +1,4 @@
+from LoopStructural.utils.exceptions import LoopException
 import numpy as np
 from typing import Optional, Union
 from LoopStructural.interpolators import (
@@ -18,12 +19,12 @@
 def get_interpolator(
     bounding_box: BoundingBox,
     interpolatortype: str,
-    dimensions: int,
     nelements: int,
     element_volume: Optional[float] = None,
     buffer: float = 0.2,
+    dimensions: int = 3,
     support=None,
-):
+) -> GeologicalInterpolator:
     # add a buffer to the interpolation domain, this is necessary for
     # faults but also generally a good
     # idea to avoid boundary problems
@@ -97,7 +98,7 @@ def get_interpolator(
             "for modelling using FDI"
         )
         return FiniteDifferenceInterpolator(grid)
-
+    raise LoopException("No interpolator")
     # fi interpolatortype == "DFI" and dfi is True:
     #     if element_volume is None:
     #         nelements /= 5

LoopStructural/interpolators/_geological_interpolator.py

@@ -230,6 +230,12 @@ def solve_system(self, **kwargs):
     def update(self):
         return False
 
+    def evaluate_value(self, locations: np.ndarray):
+        raise NotImplementedError("evaluate_value not implemented")
+
+    def evaluate_gradient(self, locations: np.ndarray):
+        raise NotImplementedError("evaluate_gradient not implemented")
+
     def clean(self):
         """
         Removes all of the data from an interpolator

LoopStructural/modelling/core/geological_model.py

@@ -890,7 +890,7 @@ def get_interpolator(
         raise InterpolatorError("Could not create interpolator")
 
     def create_and_add_foliation(
-        self, series_surface_data, tol=None, faults=None, **kwargs
+        self, series_surface_data:str, interpolatortype:str='FDI',nelements:int=1000, tol=None, faults=None, **kwargs
     ):
         """
         Parameters
@@ -923,9 +923,8 @@ def create_and_add_foliation(
         if tol is None:
             tol = self.tol
 
-        interpolator = self.get_interpolator(**kwargs)
         series_builder = GeologicalFeatureBuilder(
-            interpolator, name=series_surface_data, **kwargs
+            bounding_box=self.bounding_box, interpolatortype=interpolatortype,nelements=nelements, name=series_surface_data, **kwargs
         )
         # add data
         series_data = self.data[self.data["feature_name"] == series_surface_data]

LoopStructural/modelling/core/geological_model_builder.py

@@ -0,0 +1,38 @@
+class GeologicalModelBuilderFactory:
+    def __init__(self):
+        pass
+    
+    def create_builder(self):
+        pass
+    
+class GeologicalModelBuilder:
+    def __init__(self):
+        pass
+    
+    def set_model_name(self, name):
+        pass
+    
+    def add_surface(self, surface):
+        pass
+    
+    def add_fault(self, fault):
+        pass
+    
+    def build(self):
+        pass
+    
+class GeologicalModel:
+    def __init__(self, name):
+        pass
+    
+    def add_surface(self, surface):
+        pass
+    
+    def add_fault(self, fault):
+        pass
+    
+    def get_surface(self, name):
+        pass
+    
+    def get_fault(self, name):
+        pass

LoopStructural/modelling/features/builders/_geological_feature_builder.py

@@ -26,14 +26,17 @@
 )
 from ....utils import RegionEverywhere
 from ....interpolators import DiscreteInterpolator
+from ....interpolators import get_interpolator
 
 logger = getLogger(__name__)
 
 
 class GeologicalFeatureBuilder(BaseBuilder):
     def __init__(
         self,
-        interpolator: GeologicalInterpolator,
+        interpolatortype: str,
+        bounding_box,
+        nelements: int = 1000,
         name="Feature",
         interpolation_region=None,
         **kwargs,
@@ -56,7 +59,11 @@ def __init__(
                     type(interpolator)
                 )
             )
-        self._interpolator = interpolator
+        self._interpolator = get_interpolator(
+            bounding_box=bounding_box,
+            interpolatortype=interpolatortype,
+            nelements=nelements,
+        )
         self._interpolator.set_property_name(self._name)
         # everywhere region is just a lambda that returns true for all locations
 
@@ -198,7 +205,6 @@ def add_data_to_interpolator(
             # change gradient constraints to normal vector constraints
             mask = np.all(~np.isnan(data.loc[:, gradient_vec_names()]), axis=1)
             if mask.shape[0] > 0:
-
                 data.loc[mask, normal_vec_names()] = data.loc[
                     mask, gradient_vec_names()
                 ].to_numpy(float)
@@ -288,7 +294,6 @@ def install_gradient_constraint(self):
                 )
 
     def add_equality_constraints(self, feature, region, scalefactor=1.0):
-
         self._equality_constraints[feature.name] = [feature, region, scalefactor]
         self._up_to_date = False