Update rips module and Python examples

Author: magnesj

docs/rips/PythonExamples/wells_and_fractures/modeled_well_path.py

@@ -31,7 +31,20 @@
 coord = [1054.28, 250, -50]
 target = geometry.append_well_target(coord)
 
-well_path.append_perforation_interval(3300, 3350, 0.2, 0.76)
+perforation = well_path.append_perforation_interval(3300, 3350, 0.2, 0.76)
+
+# Make some changes to the AICD parameters of the valve template
+valve_templates = resinsight.project.valve_templates()
+aicd_template = valve_templates.valve_definitions()[0]
+aicd_parameters = aicd_template.aicd_parameters()
+aicd_parameters.max_flow_rate = 899.43
+aicd_parameters.density_calibration_fluid = 45.5
+aicd_parameters.update()
+
+# Add a valve to the perforation interval
+valve = perforation.add_valve(
+    template=aicd_template, start_md=3310, end_md=3340, valve_count=2
+)
 
 
 # Update skin factor of the perforation

docs/rips/case.py

@@ -506,7 +506,7 @@ def create_multiple_fractures(
     if isinstance(well_path_names, str):
         well_path_names = [well_path_names]
     return self._execute_command(
-        createMultipleFractures=Cmd.MultipleFracRequest(
+        createMultipleFractures=Cmd.CreateMultipleFracRequest(
             caseId=self.id,
             templateId=template_id,
             wellPathNames=well_path_names,

docs/rips/generated/Commands_pb2.py

@@ -25,6 +25,24 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if ColorLegend.__custom_init__ is not None:
             ColorLegend.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class CompletionTemplateCollection(PdmObjectBase):
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if CompletionTemplateCollection.__custom_init__ is not None:
+            CompletionTemplateCollection.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
+    def valve_templates(self) -> Optional[ValveTemplateCollection]:
+        """
+
+        Returns:
+             ValveTemplateCollection
+        """
+        children = self.children("ValveTemplates", ValveTemplateCollection)
+        return children[0] if len(children) > 0 else None
+
+
 class Case(PdmObjectBase):
     """
     The ResInsight base class for Cases
@@ -1166,6 +1184,30 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if Perforation.__custom_init__ is not None:
             Perforation.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+    def add_valve(self, start_md: float=0.000000000000000e+00, end_md: float=0.000000000000000e+00, valve_count: int=1, template: Optional[ValveTemplate]=None) -> WellPathValve:
+        """
+        Add StimPlan Fracture
+
+        Arguments:
+            start_md (float): 
+            end_md (float): 
+            valve_count (int): 
+            template (Optional[ValveTemplate]): Valve Template
+        Returns:
+            WellPathValve
+        """
+        return self._call_pdm_method_return_value("AddValve", WellPathValve, start_md=start_md, end_md=end_md, valve_count=valve_count, template=template)
+
+
+    def valves(self) -> List[WellPathValve]:
+        """Valves
+
+        Returns:
+             List[WellPathValve]
+        """
+        return self.children("Valves", WellPathValve)
+
+
 class PerforationCollection(CheckableNamedObject):
     __custom_init__ = None #: Assign a custom init routine to be run at __init__
 
@@ -1438,6 +1480,18 @@ def surface_folder(self, folder_name: str="") -> SurfaceCollection:
         return self._call_pdm_method_return_value("surfaceFolder", SurfaceCollection, folder_name=folder_name)
 
 
+    def valve_templates(self, ) -> ValveTemplateCollection:
+        """
+        Get Valve Template Collection
+
+        Arguments:
+            
+        Returns:
+            ValveTemplateCollection
+        """
+        return self._call_pdm_method_return_value("valveTemplates", ValveTemplateCollection)
+
+
     def well_path_collection(self, ) -> WellPathCollection:
         """
         Get Well Path Collection
@@ -2386,6 +2440,53 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if TriangleGeometry.__custom_init__ is not None:
             TriangleGeometry.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class ValveTemplate(NamedObject):
+    """
+    Attributes:
+        flow_coefficient (float): Flow Coefficient
+        orifice_diameter (float): Orifice Diameter [mm]
+    """
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        self.flow_coefficient: float = 7.000000000000000e-01
+        self.orifice_diameter: float = 8.000000000000000e+00
+        NamedObject.__init__(self, pb2_object, channel)
+        if ValveTemplate.__custom_init__ is not None:
+            ValveTemplate.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
+    def aicd_parameters(self) -> Optional[WellPathAicdParameters]:
+        """AICD Parameters
+
+        Returns:
+             WellPathAicdParameters
+        """
+        children = self.children("AicdParameters", WellPathAicdParameters)
+        return children[0] if len(children) > 0 else None
+
+
+class ValveTemplateCollection(PdmObjectBase):
+    """
+    Attributes:
+        valve_units (str): One of [UNITS_METRIC, UNITS_FIELD, UNITS_UNKNOWN]
+    """
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        self.valve_units: str = "UNITS_METRIC"
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if ValveTemplateCollection.__custom_init__ is not None:
+            ValveTemplateCollection.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
+    def valve_definitions(self) -> List[ValveTemplate]:
+        """
+
+        Returns:
+             List[ValveTemplate]
+        """
+        return self.children("ValveDefinitions", ValveTemplate)
+
+
 class WbsParameters(PdmObjectBase):
     """
     Attributes:
@@ -2446,6 +2547,30 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if SimulationWell.__custom_init__ is not None:
             SimulationWell.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class PlotCurve(PdmObjectBase):
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if PlotCurve.__custom_init__ is not None:
+            PlotCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
+class WellLogPlotCurve(PlotCurve):
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        PlotCurve.__init__(self, pb2_object, channel)
+        if WellLogPlotCurve.__custom_init__ is not None:
+            WellLogPlotCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
+class WellLogExtractionCurve(WellLogPlotCurve):
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        WellLogPlotCurve.__init__(self, pb2_object, channel)
+        if WellLogExtractionCurve.__custom_init__ is not None:
+            WellLogExtractionCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class WellLogPlot(DepthTrackPlot):
     """
     A Well Log Plot With a shared Depth Axis and Multiple Tracks
@@ -2494,30 +2619,6 @@ def parameters(self) -> Optional[WbsParameters]:
         return children[0] if len(children) > 0 else None
 
 
-class PlotCurve(PdmObjectBase):
-    __custom_init__ = None #: Assign a custom init routine to be run at __init__
-
-    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
-        PdmObjectBase.__init__(self, pb2_object, channel)
-        if PlotCurve.__custom_init__ is not None:
-            PlotCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
-
-class WellLogPlotCurve(PlotCurve):
-    __custom_init__ = None #: Assign a custom init routine to be run at __init__
-
-    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
-        PlotCurve.__init__(self, pb2_object, channel)
-        if WellLogPlotCurve.__custom_init__ is not None:
-            WellLogPlotCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
-
-class WellLogExtractionCurve(WellLogPlotCurve):
-    __custom_init__ = None #: Assign a custom init routine to be run at __init__
-
-    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
-        WellLogPlotCurve.__init__(self, pb2_object, channel)
-        if WellLogExtractionCurve.__custom_init__ is not None:
-            WellLogExtractionCurve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
-
 class WellLogPlotCollection(PdmObjectBase):
     __custom_init__ = None #: Assign a custom init routine to be run at __init__
 
@@ -2587,6 +2688,49 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if FileWellPath.__custom_init__ is not None:
             FileWellPath.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class WellPathAicdParameters(PdmObjectBase):
+    """
+    Attributes:
+        critical_water_liquid_fraction_emul (Optional[float]): Critical Water in Liquid Fraction for emulsions
+        density_calibration_fluid (Optional[float]): Calibration Fluid Density (kg/m^3)
+        device_open (bool): Device Open?
+        exponent_gas_density (Optional[float]): Density Exponent of Gas Fraction
+        exponent_gas_viscosity (Optional[float]): Viscosity Exponent of Gas Fraction
+        exponent_oil_density (Optional[float]): Density Exponent of Oil Fraction
+        exponent_oil_viscosity (Optional[float]): Viscosity Exponent of Oil Fraction
+        exponent_water_density (Optional[float]): Density Exponent of Water Fraction
+        exponent_water_viscosity (Optional[float]): Viscosity Exponent of Water Fraction
+        max_flow_rate (Optional[float]): Max Flow Rate for AICD Device (m^3 / day)
+        max_ratio_of_emulsion_visc (Optional[float]): Max Ratio of Emulsion to Continuous Viscosity
+        strength_aicd (Optional[float]): Strength of AICD
+        viscosity_calibration_fluid (Optional[float]): Calibration Fluid Viscosity (cP)
+        viscosity_function_exponent (Optional[float]): Viscosity Function Exponent
+        viscosity_transition_region_emul (Optional[float]): Emulsion Viscosity Transition Region
+        volume_flow_rate_exponent (Optional[float]): Volume Flow Rate Exponent
+    """
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        self.critical_water_liquid_fraction_emul: Optional[float] = None
+        self.density_calibration_fluid: Optional[float] = None
+        self.device_open: bool = True
+        self.exponent_gas_density: Optional[float] = None
+        self.exponent_gas_viscosity: Optional[float] = None
+        self.exponent_oil_density: Optional[float] = None
+        self.exponent_oil_viscosity: Optional[float] = None
+        self.exponent_water_density: Optional[float] = None
+        self.exponent_water_viscosity: Optional[float] = None
+        self.max_flow_rate: Optional[float] = None
+        self.max_ratio_of_emulsion_visc: Optional[float] = None
+        self.strength_aicd: Optional[float] = None
+        self.viscosity_calibration_fluid: Optional[float] = None
+        self.viscosity_function_exponent: Optional[float] = None
+        self.viscosity_transition_region_emul: Optional[float] = None
+        self.volume_flow_rate_exponent: Optional[float] = None
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if WellPathAicdParameters.__custom_init__ is not None:
+            WellPathAicdParameters.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class WellPathCompletionSettings(PdmObjectBase):
     """
     Attributes:
@@ -2768,6 +2912,19 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if WellPathTarget.__custom_init__ is not None:
             WellPathTarget.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+class WellPathValve(CheckableNamedObject):
+    """
+    Attributes:
+        start_measured_depth (float): Start MD
+    """
+    __custom_init__ = None #: Assign a custom init routine to be run at __init__
+
+    def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel: Optional[grpc.Channel]=None) -> None:
+        self.start_measured_depth: float = 0.000000000000000e+00
+        CheckableNamedObject.__init__(self, pb2_object, channel)
+        if WellPathValve.__custom_init__ is not None:
+            WellPathValve.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class WellPathCollection(PdmObjectBase):
     """
     Collection of Well Paths
@@ -2809,6 +2966,7 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['CheckableNamedObject'] = CheckableNamedObject
     classes['ColorLegend'] = ColorLegend
     classes['CommandRouter'] = CommandRouter
+    classes['CompletionTemplateCollection'] = CompletionTemplateCollection
     classes['CornerPointCase'] = CornerPointCase
     classes['CurveIntersection'] = CurveIntersection
     classes['DataContainerFloat'] = DataContainerFloat
@@ -2892,6 +3050,8 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['TextAnnotation'] = TextAnnotation
     classes['ThermalFractureTemplate'] = ThermalFractureTemplate
     classes['TriangleGeometry'] = TriangleGeometry
+    classes['ValveTemplate'] = ValveTemplate
+    classes['ValveTemplateCollection'] = ValveTemplateCollection
     classes['View'] = View
     classes['ViewWindow'] = ViewWindow
     classes['WbsParameters'] = WbsParameters
@@ -2902,12 +3062,14 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['WellLogPlotCurve'] = WellLogPlotCurve
     classes['WellLogPlotTrack'] = WellLogPlotTrack
     classes['WellPath'] = WellPath
+    classes['WellPathAicdParameters'] = WellPathAicdParameters
     classes['WellPathCollection'] = WellPathCollection
     classes['WellPathCompletionSettings'] = WellPathCompletionSettings
     classes['WellPathCompletions'] = WellPathCompletions
     classes['WellPathFracture'] = WellPathFracture
     classes['WellPathGeometry'] = WellPathGeometry
     classes['WellPathTarget'] = WellPathTarget
+    classes['WellPathValve'] = WellPathValve
     return classes
 
 def class_from_keyword(class_keyword : str) -> Optional[Type[PdmObjectBase]]:

docs/rips/generated/generated_classes.py

@@ -3,6 +3,7 @@
 
 sys.path.insert(1, os.path.join(sys.path[0], "../../"))
 
+import rips
 import dataroot
 
 
@@ -27,3 +28,29 @@ def test_create_lgr_well(rips_instance, initialize_test):
         split_type="LGR_PER_WELL",
     )
     assert len(case.grids()) == 3
+
+
+def test_create_multiple_fractures(rips_instance, initialize_test):
+    case = rips_instance.project.load_case(
+        dataroot.PATH + "/TEST10K_FLT_LGR_NNC/TEST10K_FLT_LGR_NNC.EGRID"
+    )
+
+    well_files = [dataroot.PATH + "/TEST10K_FLT_LGR_NNC/wellpath_a.dev"]
+    rips_instance.project.import_well_paths(well_path_files=well_files)
+
+    fracture_instances = rips_instance.project.descendants(rips.WellPathFracture)
+    assert len(fracture_instances) == 0
+
+    case.create_multiple_fractures(
+        template_id=0,
+        well_path_names="Well Path A",
+        min_dist_from_well_td=100.0,
+        max_fractures_per_well=5,
+        top_layer=1,
+        base_layer=30,
+        spacing=100.0,
+        action="REPLACE_FRACTURES",
+    )
+
+    fracture_instances = rips_instance.project.descendants(rips.WellPathFracture)
+    assert len(fracture_instances) > 0