LoopStructural 1.6.13__tar.gz → 1.6.14__tar.gz

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/datatypes/_bounding_box.py

@@ -281,6 +281,7 @@ class BoundingBox:
             origin=origin,
             maximum=maximum,
             global_origin=self.global_origin,
+            nsteps=self.nsteps,
             dimensions=self.dimensions,
         )
 

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/interpolators/__init__.py

@@ -83,8 +83,16 @@ from ..interpolators._p1interpolator import P1Interpolator
 try:
     from ..interpolators._surfe_wrapper import SurfeRBFInterpolator
 except ImportError:
-    logger.warning("Surfe is not installed, SurfeRBFInterpolator will not be available")
-    SurfeRBFInterpolator = None
+    class SurfeRBFInterpolator(GeologicalInterpolator):
+        """
+        Dummy class to handle the case where Surfe is not installed.
+        This will raise a warning when used.
+        """
+
+        def __init__(self, *args, **kwargs):
+            raise ImportError(
+                "Surfe cannot be imported. Please install Surfe. pip install surfe/ conda install -c loop3d surfe"
+            ) 
 interpolator_map = {
     InterpolatorType.BASE: GeologicalInterpolator,
     InterpolatorType.BASE_DISCRETE: DiscreteInterpolator,

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/interpolators/_finite_difference_interpolator.py

@@ -454,22 +454,28 @@ class FiniteDifferenceInterpolator(DiscreteInterpolator):
                 )
             self.up_to_date = False
 
-    def add_regularisation(self, operator, w=0.1):
-        """
 
-        Parameters
-        ----------
-        operator
-        w
 
-        Returns
-        -------
+    # def assemble_borders(self, operator, w, name='regularisation'):
+    #     """
+    #     Adds a constraint to the border of the model to force the value to be equal to the value at the border
 
-        """
-        self.assemble_inner(operator, w)
-        # self.assemble_borders()
+    #     Parameters
+    #     ----------
+    #     operator : Operator
+    #         operator to use for the regularisation
+    #     w : double
+    #         weight of the regularisation
+
+    #     Returns
+    #     -------
+
+    #     """
+    #     # First get the global indicies of the pairs of neighbours this should be an
+    #     # Nx27 array for 3d and an Nx9 array for 2d
+
+    #     global_indexes = self.support.neighbour_global_indexes()
 
-    # def assemble_borders(self, operator, w):
 
     def assemble_inner(self, operator, w, name='regularisation'):
         """

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/interpolators/_p1interpolator.py

@@ -146,7 +146,7 @@ class P1Interpolator(DiscreteInterpolator):
         self.reset()
         for key in kwargs:
             if "regularisation" in kwargs:
-                self.interpolation_weights["cgw"] = 0.1 * kwargs["regularisation"]
+                self.interpolation_weights["cgw"] = kwargs["regularisation"]
             self.up_to_date = False
             self.interpolation_weights[key] = kwargs[key]
         if self.interpolation_weights["cgw"] > 0.0:

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/interpolators/supports/_3d_structured_grid.py

@@ -437,8 +437,9 @@ class StructuredGrid(BaseStructuredSupport):
         T[:, 2, 6] = (1 - local_coords[:, 0]) * local_coords[:, 1]
         T[:, 2, 3] = -local_coords[:, 0] * local_coords[:, 1]
         T[:, 2, 7] = local_coords[:, 0] * local_coords[:, 1]
-        T /= self.step_vector[0]
-
+        T[:, 0, :] /= self.step_vector[None, 0]
+        T[:, 1, :] /= self.step_vector[None, 1]
+        T[:, 2, :] /= self.step_vector[None, 2]
         return vertices, T, elements, inside
 
     def get_element_for_location(self, pos: np.ndarray):

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/modelling/__init__.py

@@ -22,6 +22,14 @@ from ..modelling.input import (
 try:
     from ..modelling.input.project_file import LoopProjectfileProcessor
 except (LoopImportError, ImportError):
-    logger.warning(
-        "Cannot use LoopProjectfileProcessor: Loop project file cannot be imported, try installing LoopProjectFile"
-    )
+    class LoopProjectfileProcessor(ProcessInputData):
+        """
+        Dummy class to handle the case where LoopProjectFile is not installed.
+        This will raise a warning when used.
+        """
+
+        def __init__(self, *args, **kwargs):
+            raise LoopImportError(
+                "LoopProjectFile cannot be imported. Please install LoopProjectFile."
+            )
+    

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/modelling/features/builders/_geological_feature_builder.py

@@ -86,7 +86,7 @@ class GeologicalFeatureBuilder(BaseBuilder):
         self._orthogonal_features = {}
         self._equality_constraints = {}
         # add default parameters
-        self.update_build_arguments({'cpw':1.0,'npw':1.0,'regularisation':1.0,'nelements':self.interpolator.n_elements})
+        self.update_build_arguments({'cpw':1.0,'npw':1.0,'regularisation':.10,'nelements':self.interpolator.n_elements})
     def set_not_up_to_date(self, caller):
         logger.info(
             f"Setting {self.name} to not up to date from an instance of {caller.__class__.__name__}"

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/modelling/features/fault/_fault_function.py

@@ -12,7 +12,7 @@ logger = getLogger(__name__)
 def smooth_peak(x):
     v = np.zeros(x.shape)
     mask = np.logical_and(x >= -1, x <= 1)
-    v[mask] = 0.25 * x[mask] ** 2 + 0.5 * x[mask] ** 4 - 1.75 * x[mask] ** 2 + 1
+    v[mask] = x[mask] ** 4 - 2 * x[mask] ** 2 + 1
     return v
 
 class FaultProfileFunction(metaclass=ABCMeta):

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/utils/__init__.py

@@ -23,6 +23,7 @@ from .maths import (
     get_strike_vector,
     get_vectors,
     strikedip2vector,
+    plungeazimuth2vector,
     azimuthplunge2vector,
     normal_vector_to_strike_and_dip,
     rotate,

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/utils/helper.py

@@ -107,30 +107,7 @@ def get_data_bounding_box(xyz, buffer):
     return bb, region
 
 
-# def azimuthplunge2vector(
-#     plunge: Union[np.ndarray, list], plunge_dir: Union[np.ndarray, list]
-# ) -> np.ndarray:
-#     """Convert plunge and plunge direction to a vector
-
-#     Parameters
-#     ----------
-#     plunge : Union[np.ndarray, list]
-#         array or array like of plunge values
-#     plunge_dir : Union[np.ndarray, list]
-#         array or array like of plunge direction values
-
-#     Returns
-#     -------
-#     np.array
-#         nx3 vector
-#     """
-#     plunge = np.deg2rad(plunge)
-#     plunge_dir = np.deg2rad(plunge_dir)
-#     vec = np.zeros(3)
-#     vec[0] = np.sin(plunge_dir) * np.cos(plunge)
-#     vec[1] = np.cos(plunge_dir) * np.cos(plunge)
-#     vec[2] = -np.sin(plunge)
-#     return vec
+
 
 
 def create_surface(bounding_box, nstep):

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural/utils/maths.py

@@ -28,20 +28,28 @@ def strikedip2vector(strike: NumericInput, dip: NumericInput) -> np.ndarray:
     vec /= np.linalg.norm(vec, axis=1)[:, None]
     return vec
 
-
 def azimuthplunge2vector(
+        plunge: NumericInput,
+        azimuth: NumericInput,
+        degrees: bool = True,
+) -> np.ndarray:
+    raise DeprecationWarning(
+        "azimuthplunge2vector is deprecated, use plungeazimuth2vector instead"
+    )
+
+def plungeazimuth2vector(
     plunge: NumericInput,
-    plunge_dir: NumericInput,
+    azimuth: NumericInput,
     degrees: bool = True,
 ) -> np.ndarray:
     """Convert plunge and plunge direction to a vector
 
     Parameters
     ----------
+    azimuth : Union[np.ndarray, list]
+        array or array like of plunge direction values
     plunge : Union[np.ndarray, list]
         array or array like of plunge values
-    plunge_dir : Union[np.ndarray, list]
-        array or array like of plunge direction values
 
     Returns
     -------
@@ -52,16 +60,16 @@ def azimuthplunge2vector(
         plunge = np.array([plunge], dtype=float)
     else:
         plunge = np.array(plunge, dtype=float)
-    if isinstance(plunge_dir, numbers.Number):
-        plunge_dir = np.array([plunge_dir], dtype=float)
+    if isinstance(azimuth, numbers.Number):
+        azimuth = np.array([azimuth], dtype=float)
     else:
-        plunge_dir = np.array(plunge_dir, dtype=float)
+        azimuth = np.array(azimuth, dtype=float)
     if degrees:
         plunge = np.deg2rad(plunge)
-        plunge_dir = np.deg2rad(plunge_dir)
+        azimuth = np.deg2rad(azimuth)
     vec = np.zeros((len(plunge), 3))
-    vec[:, 0] = np.sin(plunge_dir) * np.cos(plunge)
-    vec[:, 1] = np.cos(plunge_dir) * np.cos(plunge)
+    vec[:, 0] = np.sin(azimuth) * np.cos(plunge)
+    vec[:, 1] = np.cos(azimuth) * np.cos(plunge)
     vec[:, 2] = -np.sin(plunge)
     return vec
 
@@ -204,19 +212,21 @@ def get_vectors(normal: NumericInput) -> Tuple[np.ndarray, np.ndarray]:
 
 
 def get_strike_vector(strike: NumericInput, degrees: bool = True) -> np.ndarray:
-    """Return the vector aligned with the strike direction
+    """Return strike direction vector(s) from strike angle(s).
 
     Parameters
     ----------
-    strike : np.ndarray
-        strike direction
+    strike : NumericInput
+        Single strike angle or array-like of strike angles, measured clockwise from North.
     degrees : bool, optional
-        whether to return in degrees or radians, by default True
+        Whether the input angles are in degrees. If False, angles are assumed to be in radians.
+        Default is True.
 
     Returns
     -------
     np.ndarray
-        vector aligned with strike direction
+        Array of shape (3, n) where each column is a 3D unit vector (x, y, z) representing
+        the horizontal strike direction. The z-component is always 0.
 
     """
     if isinstance(strike, numbers.Number):
@@ -236,6 +246,21 @@ def get_strike_vector(strike: NumericInput, degrees: bool = True) -> np.ndarray:
 
 
 def get_dip_vector(strike, dip):
+    """Return the dip vector based on strike and dip angles.
+
+    Parameters
+    ----------
+    strike : float
+        Strike angle in degrees, measured clockwise from North.
+    dip : float
+        Dip angle in degrees, measured from the horizontal plane.
+
+    Returns
+    -------
+    np.ndarray
+        Unit vector (length 3) representing the dip direction in 3D space.
+
+    """
     v = np.array(
         [
             -np.cos(np.deg2rad(-strike)) * np.cos(-np.deg2rad(dip)),
@@ -247,6 +272,23 @@ def get_dip_vector(strike, dip):
 
 
 def regular_tetraherdron_for_points(xyz, scale_parameter):
+    """Generate regular tetrahedrons centered at given 3D points.
+
+    Parameters
+    ----------
+    xyz : np.ndarray
+        Array of shape (n, 3) representing the coordinates of n points in 3D space,
+        which will serve as the centers of the generated tetrahedrons.
+    scale_parameter : float
+        Scaling factor controlling the size of the regular tetrahedrons.
+
+    Returns
+    -------
+    np.ndarray
+        Array of shape (n, 4, 3) representing n regular tetrahedrons, where each
+        tetrahedron has 4 vertices in 3D space, positioned relative to the corresponding center point.
+
+    """
     regular_tetrahedron = np.array(
         [
             [np.sqrt(8 / 9), 0, -1 / 3],
@@ -264,8 +306,23 @@ def regular_tetraherdron_for_points(xyz, scale_parameter):
 
 
 def gradient_from_tetrahedron(tetrahedron, value):
-    """
-    Calculate the gradient from a tetrahedron
+    """Compute the gradient of values within tetrahedral elements
+
+    Parameters
+    ----------
+    tetrahedron : np.ndarray
+        Array of shape (n, 4, 3) representing the coordinates of tetrahedral elements,
+        where each tetrahedron is defined by 4 vertices in 3D space.
+    value : np.ndarray
+        Array of shape (n, 4) representing the scalar values at the 4 vertices
+        of each tetrahedron.
+
+    Returns
+    -------
+    np.ndarray
+        Array of shape (n, 3) representing the gradient vector of the scalar field
+        inside each tetrahedral element.
+
     """
     tetrahedron = tetrahedron.reshape(-1, 4, 3)
     m = np.array(

loopstructural-1.6.14/LoopStructural/version.py

@@ -0,0 +1 @@
+__version__ = "1.6.14"

{loopstructural-1.6.13 → loopstructural-1.6.14}/LoopStructural.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LoopStructural
-Version: 1.6.13
+Version: 1.6.14
 Summary: 3D geological modelling
 Author-email: Lachlan Grose <lachlan.grose@monash.edu>
 License: MIT

{loopstructural-1.6.13 → loopstructural-1.6.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: LoopStructural
-Version: 1.6.13
+Version: 1.6.14
 Summary: 3D geological modelling
 Author-email: Lachlan Grose <lachlan.grose@monash.edu>
 License: MIT

loopstructural-1.6.13/LoopStructural/version.py

@@ -1 +0,0 @@
-__version__ = "1.6.13"