Update rips module and Python examples

magnesj · magnesj · commit a456e51e06a6 · 2025-08-07T08:30:01.000+02:00
diff --git a/docs/rips/PythonExamples/wells_and_fractures/modeled_well_path.py b/docs/rips/PythonExamples/wells_and_fractures/modeled_well_path.py
@@ -67,6 +67,12 @@
 msw_settings.user_defined_reference_md = 0
 msw_settings.update()
 
+# Optionally update the Perforation Non-Darcy settings
+non_darcy_parameters = perforation_coll.non_darcy_parameters()
+non_darcy_parameters.non_darcy_flow_type = "UserDefined"
+non_darcy_parameters.user_defined_d_factor = 1.2345
+non_darcy_parameters.update()
+
 # export completions
 cases = resinsight.project.cases()
 
diff --git a/docs/rips/generated/generated_classes.py b/docs/rips/generated/generated_classes.py
@@ -1043,6 +1043,35 @@ def well_path_geometry(self) -> Optional[WellPathGeometry]:
         return children[0] if len(children) > 0 else None
 
 
+class NonDarcyPerforationParameters(PdmObjectBase):
+    """
+    Attributes:
+        gas_viscosity (float): <html>Gas Viscosity (&mu;)</html> [cP]
+        grid_permeability_scaling_factor (float): <html>Grid Permeability Scaling Factor (K<sub>r</sub>) [0..1]</html>
+        inertial_coefficient (float): <html>Inertial Coefficient (&beta;<sub>0</sub>)</html> [Forch. unit]
+        non_darcy_flow_type (str): One of [None, Computed, UserDefined]
+        permeability_scaling_factor (float): Permeability Scaling Factor (B)
+        porosity_scaling_factor (float): Porosity Scaling Factor (C)
+        relative_gas_density (float): <html>Relative Gas Density (&gamma;)</html>
+        user_defined_d_factor (float): D Factor
+        well_radius (float): <html>Well Radius (r<sub>w</sub>)</html> [m]
+    """
+    __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.gas_viscosity: float = 2.000000000000000e-02
+        self.grid_permeability_scaling_factor: float = 1.000000000000000e+00
+        self.inertial_coefficient: float = 8.839000000000000e+02
+        self.non_darcy_flow_type: str = "None"
+        self.permeability_scaling_factor: float = -1.104500000000000e+00
+        self.porosity_scaling_factor: float = 0.000000000000000e+00
+        self.relative_gas_density: float = 8.000000000000000e-01
+        self.user_defined_d_factor: float = 1.000000000000000e+00
+        self.well_radius: float = 1.080000000000000e-01
+        PdmObjectBase.__init__(self, pb2_object, channel)
+        if NonDarcyPerforationParameters.__custom_init__ is not None:
+            NonDarcyPerforationParameters.__custom_init__(self, pb2_object=pb2_object, channel=channel)
+
 class NonNetLayers(PdmObjectBase):
     """
     Attributes:
@@ -1107,6 +1136,16 @@ def __init__(self, pb2_object: Optional[PdmObject_pb2.PdmObject]=None, channel:
         if PerforationCollection.__custom_init__ is not None:
             PerforationCollection.__custom_init__(self, pb2_object=pb2_object, channel=channel)
 
+    def non_darcy_parameters(self) -> Optional[NonDarcyPerforationParameters]:
+        """Non-Darcy Parameters
+
+        Returns:
+             NonDarcyPerforationParameters
+        """
+        children = self.children("NonDarcyParameters", NonDarcyPerforationParameters)
+        return children[0] if len(children) > 0 else None
+
+
     def perforations(self) -> List[Perforation]:
         """Perforations
 
@@ -2752,6 +2791,7 @@ def class_dict() -> Dict[str, Type[PdmObjectBase]]:
     classes['MswSettings'] = MswSettings
     classes['MudWeightWindowParameters'] = MudWeightWindowParameters
     classes['NamedObject'] = NamedObject
+    classes['NonDarcyPerforationParameters'] = NonDarcyPerforationParameters
     classes['NonNetLayers'] = NonNetLayers
     classes['OsduWellPath'] = OsduWellPath
     classes['PdmObjectBase'] = PdmObjectBase
diff --git a/docs/rips/tests/test_wells_path_completions.py b/docs/rips/tests/test_wells_path_completions.py
@@ -190,3 +190,49 @@ def test_fishbone_interface(rips_instance, initialize_test):
     assert fishbones_updated.lateral_tubing_diameter == 0.1
     assert fishbones_updated.lateral_tubing_roghness_factor == 0.1
     assert fishbones_updated.subs_orientation_mode == "FIXED"
+
+
+# test perforations and perforations settings
+def test_perforation_settings(rips_instance, initialize_test):
+    well_path_coll = rips_instance.project.descendants(rips.WellPathCollection)[0]
+
+    well_path = well_path_coll.add_new_object(rips.ModeledWellPath)
+    well_path.name = "perforated_well"
+    well_path.update()
+
+    perforation_coll = well_path.completions().perforations()
+    non_darcy_parameters = perforation_coll.non_darcy_parameters()
+    non_darcy_parameters.non_darcy_flow_type = "UserDefined"
+    non_darcy_parameters.user_defined_d_factor = 1.2345
+    non_darcy_parameters.update()
+
+    non_darcy_parameters_updated = perforation_coll.non_darcy_parameters()
+    assert non_darcy_parameters_updated.non_darcy_flow_type == "UserDefined"
+    assert non_darcy_parameters_updated.user_defined_d_factor == 1.2345
+
+    non_darcy_parameters = perforation_coll.non_darcy_parameters()
+    non_darcy_parameters.non_darcy_flow_type = "None"
+    non_darcy_parameters.update()
+    non_darcy_parameters_updated = perforation_coll.non_darcy_parameters()
+    assert non_darcy_parameters_updated.non_darcy_flow_type == "None"
+
+    non_darcy_parameters = perforation_coll.non_darcy_parameters()
+    non_darcy_parameters.non_darcy_flow_type = "Computed"
+    non_darcy_parameters.gas_viscosity = 1.2
+    non_darcy_parameters.grid_permeability_scaling_factor = 20
+    non_darcy_parameters.inertial_coefficient = 1.1
+    non_darcy_parameters.permeability_scaling_factor = 0.14
+    non_darcy_parameters.porosity_scaling_factor = 0.59
+    non_darcy_parameters.relative_gas_density = 0.23
+    non_darcy_parameters.well_radius = 12.12
+
+    non_darcy_parameters.update()
+    non_darcy_parameters_updated = perforation_coll.non_darcy_parameters()
+    assert non_darcy_parameters_updated.non_darcy_flow_type == "Computed"
+    assert non_darcy_parameters_updated.gas_viscosity == 1.2
+    assert non_darcy_parameters_updated.grid_permeability_scaling_factor == 20
+    assert non_darcy_parameters_updated.inertial_coefficient == 1.1
+    assert non_darcy_parameters_updated.permeability_scaling_factor == 0.14
+    assert non_darcy_parameters_updated.porosity_scaling_factor == 0.59
+    assert non_darcy_parameters_updated.relative_gas_density == 0.23
+    assert non_darcy_parameters_updated.well_radius == 12.12
