Initial cleanup of parameters, still need to hookup topography_above_point method to convert input depth to elevation used by Plate objects

Author: benk-mira

simpeg_drivers-assets/uijson/plate_simulation.ui.json

@@ -117,64 +117,13 @@
         "max": 360.0,
         "tooltip": "Direction of the dip vector in degrees from north"
     },
-    "relative_locations": {
-        "label": "Relative locations",
-        "main": true,
-        "group": "Plate",
-        "value": true,
-        "enabled": true,
-        "tooltip": "If checked locations are relative to the survey centre and either topography or overburden in z according to 'Depth reference' selection"
-    },
-    "easting": {
-        "label": "Easting (m)",
-        "group": "Plate",
-        "main": true,
-        "value": 0.0,
-        "enabled": true,
-        "tooltip": "If relative locations, easting is relative to the centre of the survey"
-    },
-    "northing": {
-        "label": "Northing (m)",
-        "main": true,
-        "group": "Plate",
-        "value": 0.0,
-        "enabled": true,
-        "tooltip": "If relative locations, northing is relative to the centre of the survey"
-    },
     "elevation": {
-        "label": "Elevation (m)",
+        "label": "Depth (m)",
         "main": true,
         "group": "Plate",
         "value": 0.0,
         "enabled": true,
-        "tooltip": "If relative location, elevation is relative to the topography or overburden according to 'Depth reference' selection"
-    },
-    "reference_surface": {
-        "label": "Depth reference",
-        "main": true,
-        "group": "Plate",
-        "dependency": "relative_locations",
-        "dependencyType": "enabled",
-        "choiceList": [
-            "topography",
-            "overburden"
-        ],
-        "tooltop": "If relative locations, the depth will be below the min/mean/max (according to 'Reference type') of the reference surface chosen.",
-        "value": "overburden"
-    },
-    "reference_type": {
-        "label": "Reference type",
-        "main": true,
-        "group": "Plate",
-        "dependency": "relative_locations",
-        "dependencyType": "enabled",
-        "choiceList": [
-            "min",
-            "mean",
-            "max"
-        ],
-        "tooltip": "If relative locations, the depth will be below the min/mean/max of the 'Depth reference' chosen",
-        "value": "min"
+        "tooltip": "Depth below topography above the plate."
     },
     "generate_sweep": {
         "label": "Generate sweep file",

simpeg_drivers/plate_simulation/driver.py

@@ -126,19 +126,17 @@ def survey(self):
 
         return self._survey
 
+    @property
+    def topography(self) -> Surface | Points:
+        return self.simulation_parameters.active_cells.topography_object
+
     @property
     def plates(self) -> list[Plate]:
         """Generate sequence of plates."""
         if self._plates is None:
-            offset = (
-                self.params.model.overburden_options.thickness
-                if self.params.model.plate_options.reference_surface == "overburden"
-                else 0.0
-            )
             center = self.params.model.plate_options.center(
                 self.survey,
                 self.topography,
-                depth_offset=-1 * offset,
             )
             plate = Plate(
                 self.params.model.plate_options.geometry.model_copy(
@@ -157,10 +155,6 @@ def plates(self) -> list[Plate]:
             )
         return self._plates
 
-    @property
-    def topography(self) -> Surface | Points:
-        return self.simulation_parameters.active_cells.topography_object
-
     @property
     def mesh(self) -> Octree:
         """Returns an octree mesh built from mesh parameters."""

simpeg_drivers/plate_simulation/models/events.py

@@ -11,6 +11,7 @@
 from abc import ABC, abstractmethod
 
 import numpy as np
+from geoapps_utils.modelling.plates import Plate
 from geoh5py.objects import Octree, Surface
 from geoh5py.shared.utils import find_unique_name
 
@@ -163,7 +164,7 @@ class Anomaly(Event):
     :param name: Name of the event.
     """
 
-    def __init__(self, body: Parametric, value: float, name: str = "Anomaly"):
+    def __init__(self, body: Parametric | Plate, value: float, name: str = "Anomaly"):
         self.body = body
         super().__init__(value, name)
 

simpeg_drivers/plate_simulation/models/options.py

@@ -36,13 +36,6 @@ class PlateOptions(BaseModel):
     :param geometry: Parameters describing the plate geometry.
     :param number: Number of offset plates to be created.
     :param spacing: Spacing between plates.
-    :param relative_locations: If True locations are relative to survey in xy and
-        mean topography in z.
-    :param reference_surface: Switches between using topography and overburden as
-        elevation reference of the plate.
-    :param reference_type: Type of reference for plate elevation.  Can be 'mean'
-        'min', or 'max'.  Resulting elevation will be relative to the mean,
-        minimum, or maximum of the reference surface.
     """
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
@@ -54,31 +47,17 @@ class PlateOptions(BaseModel):
     geometry: PlateModel
     number: int = 1
     spacing: float = 0.0
-    relative_locations: bool = False
-    reference_surface: str = "topography"
-    reference_type: str = "mean"
-
-    @field_validator("reference_surface", "reference_type", mode="before")
-    @classmethod
-    def none_to_default(cls, value: T | None, info: ValidationInfo) -> T:
-        return value or cls.model_fields[info.field_name].default  # pylint: disable=unsubscriptable-object
 
     @model_validator(mode="after")
     def single_plate(self):
         if self.number == 1:
             self.spacing = 0.0
         return self
 
-    @property
-    def halfplate(self):
-        """Compute half the z-projection length of the plate."""
-        return 0.5 * self.geometry.dip_length * np.sin(np.deg2rad(self.geometry.dip))
-
     def center(
         self,
         survey: Points,
         surface: Points,
-        depth_offset: float = 0.0,
     ) -> tuple[float, float, float]:
         """
         Find the plate center relative to a survey and topography.
@@ -87,36 +66,14 @@ def center(
         :param surface: Points-like object to reference plate depth from.
         :param depth_offset: Additional offset to be added to the depth of the plate.
         """
-        return *self._get_xy(survey), self._get_z(surface, depth_offset)
-
-    def _get_xy(self, survey: Points) -> tuple[float, float]:
-        """Return true or relative locations in x and y."""
 
-        if self.relative_locations:
-            return (
-                survey.vertices[:, 0].mean() + self.geometry.origin[0],
-                survey.vertices[:, 1].mean() + self.geometry.origin[1],
-            )
+        xy = (
+            survey.vertices[:, 0].mean() + self.geometry.origin[0],
+            survey.vertices[:, 1].mean() + self.geometry.origin[1],
+        )
+        z_topo = topography_above_point(topography=surface, point=xy)  # TODO
 
-        return self.geometry.origin[0], self.geometry.origin[1]
-
-    def _get_z(self, surface: Points, offset: float = 0.0) -> float:
-        """
-        Return true or relative locations in z.
-
-        :param surface: Points-like object to reference plate depth from.
-        :offset: Additional offset to be added to the depth.
-
-        """
-        if surface.vertices is None:
-            raise ValueError("Topography object has no vertices.")
-        if self.relative_locations:
-            z = getattr(surface.vertices[:, 2], self.reference_type)()
-            z += offset + self.geometry.elevation - self.halfplate
-        else:
-            z = self.geometry.elevation
-
-        return z
+        return xy + (z_topo - self.geometry.elevation,)
 
 
 class OverburdenOptions(BaseModel):