Update rips module, proto files, and Python examples

Author: magnesj

docs/proto/Case.proto

@@ -21,6 +21,7 @@ service Case {
   rpc GetCaseInfo(CaseRequest) returns (CaseInfo) {}
   rpc GetPdmObject(CaseRequest) returns (PdmObject) {}
   rpc GetReservoirBoundingBox(CaseRequest) returns (BoundingBox) {}
+  rpc GetDistanceToClosestFault(ClosestFaultRequest) returns (ClosestFault) {}
 }
 
 message CaseRequest { int32 id = 1; }
@@ -103,3 +104,14 @@ message SelectedCell {
 }
 
 message SelectedCells { repeated SelectedCell cells = 1; }
+
+message ClosestFaultRequest {
+  CaseRequest case_request = 1;
+  Vec3d point = 2;
+}
+
+message ClosestFault {
+  string fault_name = 1;
+  double distance = 2;
+  string face_name = 3;
+}

docs/rips/PythonExamples/case_and_grid_operations/fault_distance.py

@@ -0,0 +1,35 @@
+###################################################################################
+# This example prints the distance to and the name of the fault closest to a point
+###################################################################################
+
+import rips
+
+resinsight = rips.Instance.find()
+if resinsight is None:
+    exit(1)
+
+cases = resinsight.project.cases()
+if len(cases) == 0:
+    exit(1)
+
+case = cases[0]
+print("Using case: " + case.name)
+
+# random test point (positive Z for depth)
+point_x = 5039.84
+point_y = 6303.76
+point_z = 4144.21
+
+print("Looking for closest fault to point %f, %f, %f:" % (point_x, point_y, point_z))
+
+faultname, distance, facename = case.distance_to_closest_fault(
+    point_x, point_y, point_z
+)
+
+if facename == "":
+    print("- No fault found!")
+else:
+    print(
+        "- Distance to closest fault %s is %f, closest face direction is %s"
+        % (faultname, distance, facename)
+    )

docs/rips/case.py

@@ -43,6 +43,7 @@
 import Case_pb2_grpc
 import Commands_pb2 as Cmd
 import PdmObject_pb2 as PdmObject_pb2
+import Definitions_pb2
 
 import Properties_pb2
 import Properties_pb2_grpc
@@ -300,6 +301,17 @@ def reservoir_boundingbox(self):
     return self.__case_stub.GetReservoirBoundingBox(self.__request())
 
 
+@add_method(Case)
+def distance_to_closest_fault(self, x: float, y: float, z: float):
+    """Find the closest fault to the given point and return the distance, fault name and fault face"""
+    request = Case_pb2.ClosestFaultRequest(
+        case_request=self.__request(), point=Definitions_pb2.Vec3d(x=x, y=y, z=z)
+    )
+    reply = self.__case_stub.GetDistanceToClosestFault(request)
+
+    return (reply.fault_name, reply.distance, reply.face_name)
+
+
 @add_method(Case)
 def reservoir_depth_range(self) -> Tuple[float, float]:
     """Get the reservoir depth range

docs/rips/generated/Case_pb2.py

@@ -96,6 +96,11 @@ def __init__(self, channel):
                 request_serializer=Case__pb2.CaseRequest.SerializeToString,
                 response_deserializer=Case__pb2.BoundingBox.FromString,
                 _registered_method=True)
+        self.GetDistanceToClosestFault = channel.unary_unary(
+                '/rips.Case/GetDistanceToClosestFault',
+                request_serializer=Case__pb2.ClosestFaultRequest.SerializeToString,
+                response_deserializer=Case__pb2.ClosestFault.FromString,
+                _registered_method=True)
 
 
 class CaseServicer(object):
@@ -173,6 +178,12 @@ def GetReservoirBoundingBox(self, request, context):
         context.set_details('Method not implemented!')
         raise NotImplementedError('Method not implemented!')
 
+    def GetDistanceToClosestFault(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
 
 def add_CaseServicer_to_server(servicer, server):
     rpc_method_handlers = {
@@ -236,6 +247,11 @@ def add_CaseServicer_to_server(servicer, server):
                     request_deserializer=Case__pb2.CaseRequest.FromString,
                     response_serializer=Case__pb2.BoundingBox.SerializeToString,
             ),
+            'GetDistanceToClosestFault': grpc.unary_unary_rpc_method_handler(
+                    servicer.GetDistanceToClosestFault,
+                    request_deserializer=Case__pb2.ClosestFaultRequest.FromString,
+                    response_serializer=Case__pb2.ClosestFault.SerializeToString,
+            ),
     }
     generic_handler = grpc.method_handlers_generic_handler(
             'rips.Case', rpc_method_handlers)
@@ -570,3 +586,30 @@ def GetReservoirBoundingBox(request,
             timeout,
             metadata,
             _registered_method=True)
+
+    @staticmethod
+    def GetDistanceToClosestFault(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/rips.Case/GetDistanceToClosestFault',
+            Case__pb2.ClosestFaultRequest.SerializeToString,
+            Case__pb2.ClosestFault.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

docs/rips/generated/Case_pb2_grpc.py

@@ -0,0 +1,30 @@
+import sys
+import os
+import math
+import pytest
+
+sys.path.insert(1, os.path.join(sys.path[0], "../../"))
+import rips
+
+import dataroot
+
+
+def test_faultDistance(rips_instance, initialize_test):
+    case = rips_instance.project.load_case(
+        dataroot.PATH + "/TEST10K_FLT_LGR_NNC/TEST10K_FLT_LGR_NNC.EGRID"
+    )
+
+    # a test point
+    point_x = 4817.84
+    point_y = 5204.76
+    point_z = 4137.21
+
+    faultname, distance, facename = case.distance_to_closest_fault(
+        point_x, point_y, point_z
+    )
+
+    # Fault name is unstable between grid readers, so we skip this check
+    # assert faultname == "Undefined Grid Faults"
+
+    assert facename == "I+"
+    assert math.isclose(distance, 53.84, abs_tol=0.1)

docs/rips/tests/test_faults.py

@@ -66,6 +66,16 @@ Export Corner Point Grid
    :linenos:
    :caption: export_corner_point_grid.py
 
+.. _case_and_grid_operations_fault_distance:
+
+Fault Distance
+--------------
+
+.. literalinclude:: ../rips/PythonExamples/case_and_grid_operations/fault_distance.py
+   :language: python
+   :linenos:
+   :caption: fault_distance.py
+
 .. _case_and_grid_operations_grid_information:
 
 Grid Information