completor 1.1.2__py3-none-any.whl → 1.2.0__py3-none-any.whl

completor/completion.py

@@ -551,7 +551,7 @@ def get_device(df_well: pd.DataFrame, df_device: pd.DataFrame, device_type: str)
     Args:
         df_well: Must contain device type, device number, and the scaling factor.
         df_device: Device table.
-        device_type: Device type. `AICD`, `ICD`, `DAR`, `VALVE`, `AICV`, `ICV`.
+        device_type: Device type. `AICD`, `ICD`, `DENSITY`, `VALVE`, `DUALRCP`, `ICV`, `INJV`.
 
     Returns:
         Updated well information with device characteristics.
@@ -561,7 +561,14 @@ def get_device(df_well: pd.DataFrame, df_device: pd.DataFrame, device_type: str)
     """
     columns = [Headers.DEVICE_TYPE, Headers.DEVICE_NUMBER]
     try:
-        df_well = pd.merge(df_well, df_device, how="left", on=columns)
+        df_well = pd.merge(df_well, df_device, how="left", on=columns, suffixes=("", "_drop"))
+        # check for duplicates if merging two WSEGVALV-es
+        for col in df_well.columns:
+            if col.endswith("_drop"):
+                base_col = col.replace("_drop", "")
+                if base_col in df_well.columns:
+                    df_well[base_col] = df_well[base_col].fillna(df_well[col])  # Fill NaN values
+        df_well = df_well.drop(columns=[col for col in df_well.columns if col.endswith("_drop")])
     except KeyError as err:
         if f"'{Headers.DEVICE_TYPE}'" in str(err):
             raise ValueError(f"Missing keyword 'DEVICETYPE {device_type}' in input files.") from err
@@ -570,7 +577,11 @@ def get_device(df_well: pd.DataFrame, df_device: pd.DataFrame, device_type: str)
         # rescale the Cv
         # because no scaling factor in WELL_SEGMENTS_VALVE
         df_well[Headers.FLOW_COEFFICIENT] = -df_well[Headers.FLOW_COEFFICIENT] / df_well[Headers.SCALE_FACTOR]
-    elif device_type == Content.DENSITY_ACTIVATED_RECOVERY:
+    elif device_type == Content.DENSITY:
+        # rescale the Cv
+        # because no scaling factor in WELL_SEGMENTS_VALVE
+        df_well[Headers.FLOW_COEFFICIENT] = -df_well[Headers.FLOW_COEFFICIENT] / df_well[Headers.SCALE_FACTOR]
+    elif device_type == Content.INJECTION_VALVE:
         # rescale the Cv
         # because no scaling factor in WELL_SEGMENTS_VALVE
         df_well[Headers.FLOW_COEFFICIENT] = -df_well[Headers.FLOW_COEFFICIENT] / df_well[Headers.SCALE_FACTOR]

completor/constants.py

@@ -78,7 +78,7 @@ class _Headers:
     DR = "DR"
     FLAG = "FLAG"  # This is actually a header, but OPEN, SHUT, and AUTO are its possible values, see manual on COMPLETION_DATA.
     SHUT = "SHUT"
-    # CROSS = "CROSS"
+    CROSS = "CROSS"
     PRESSURE_TABLE = "PRESSURETABLE"
     DENSITY_CALCULATION_TYPE = "DENSCAL"  # Type of density calculation for the wellbore hydrostatic head.
     REGION = "REGION"
@@ -126,6 +126,7 @@ class _Headers:
     # This stops making sense from here on out?
     X = "X"
     Y = "Y"
+    Z = "Z"
     # FLAG
     A = "A"
     B = "B"
@@ -153,7 +154,7 @@ class _Headers:
     # 11. The length of the valve, lVAL (Scale factor).
     # 12. An integer which determines how the flow scaling factor is calculated.
 
-    # Density Activated Recovery Well Segments (WSEGDAR)
+    # Density Driven Well Segments (WSEGDENSITY)
     # DEVICE_NUMBER
     # FLOW_COEFFICIENT / Cv
     # FLOW_CROSS_SECTIONAL_AREA
@@ -165,6 +166,15 @@ class _Headers:
     GAS_HOLDUP_FRACTION_LOW_CUTOFF = "GAS_HOLDUP_FRACTION_LOW_CUTOFF"
     GAS_HOLDUP_FRACTION_HIGH_CUTOFF = "GAS_HOLDUP_FRACTION_HIGH_CUTOFF"
 
+    # Injection Valve Well Segments (WSEGINJV)
+    # DEVICE_NUMBER
+    TRIGGER_PARAMETER = "TRIGGER_PARAMETER"
+    TRIGGER_VALUE = "TRIGGER_VALUE"
+    # FLOW_COEFFICIENT / Cv
+    # FLOW_CROSS_SECTIONAL_AREA
+    PRIMARY_FLOW_CROSS_SECTIONAL_AREA = "PRIMARY_FLOW_CROSS_SECTIONAL_AREA"
+    SECONDARY_FLOW_CROSS_SECTIONAL_AREA = "SECONDARY_FLOW_CROSS_SECTIONAL_AREA"
+
     # Miscellaneous
     DEFAULTS = "DEFAULTS"
     MEASURED_DEPTH = "MEASURED_DEPTH"
@@ -186,10 +196,10 @@ class _Headers:
     LATERAL = "LATERAL"
     NUMBER_OF_DEVICES = "NUMBER_OF_DEVICES"
     SEGMENT_DESC = "SEGMENT_DESC"
-    AICV_WATER_CUT = "AICV_WATER_CUT"
-    AICV_GAS_HOLDUP_FRACTION = "AICV_GAS_HOLDUP_FRACTION"
-    AICV_CALIBRATION_FLUID_DENSITY = "AICV_CALIBRATION_FLUID_DENSITY"
-    AICV_FLUID_VISCOSITY = "AICV_FLUID_VISCOSITY"
+    DUALRCP_WATER_CUT = "DUALRCP_WATER_CUT"
+    DUALRCP_GAS_HOLDUP_FRACTION = "DUALRCP_GAS_HOLDUP_FRACTION"
+    DUALRCP_CALIBRATION_FLUID_DENSITY = "DUALRCP_CALIBRATION_FLUID_DENSITY"
+    DUALRCP_FLUID_VISCOSITY = "DUALRCP_FLUID_VISCOSITY"
     AICD_CALIBRATION_FLUID_DENSITY = "AICD_CALIBRATION_FLUID_DENSITY"
     AICD_FLUID_VISCOSITY = "AICD_FLUID_VISCOSITY"
     ALPHA_MAIN = "ALPHA_MAIN"
@@ -239,10 +249,13 @@ class _Keywords:
     WELL_SEGMENTS_LINK = "WSEGLINK"
     WELL_SEGMENTS_VALVE = "WSEGVALV"
     AUTONOMOUS_INFLOW_CONTROL_DEVICE = "WSEGAICD"
+    DUAL_RATE_CONTROLLED_PRODUCTION = "WSEGDUALRCP"
     AUTONOMOUS_INFLOW_CONTROL_VALVE = "WSEGAICV"
     INFLOW_CONTROL_VALVE = "WSEGICV"
     INFLOW_CONTROL_DEVICE = "WSEGSICD"
+    DENSITY = "WSEGDENSITY"
     DENSITY_ACTIVATED_RECOVERY = "WSEGDAR"
+    INJECTION_VALVE = "WSEGINJV"
     LATERAL_TO_DEVICE = "LATERAL_TO_DEVICE"
     JOINT_LENGTH = "JOINTLENGTH"
     SEGMENT_LENGTH = "SEGMENTLENGTH"
@@ -282,15 +295,21 @@ class _Content:
 
     PERFORATED = "PERF"
     INFLOW_CONTROL_VALVE = "ICV"
+    DUAL_RATE_CONTROLLED_PRODUCTION = "DUALRCP"
     AUTONOMOUS_INFLOW_CONTROL_VALVE = "AICV"
     INFLOW_CONTROL_DEVICE = "ICD"
     AUTONOMOUS_INFLOW_CONTROL_DEVICE = "AICD"
+    DENSITY = "DENSITY"
     DENSITY_ACTIVATED_RECOVERY = "DAR"
+    INJECTION_VALVE = "INJV"
     VALVE = "VALVE"
     DEVICE_TYPES = [
         AUTONOMOUS_INFLOW_CONTROL_DEVICE,
+        DUAL_RATE_CONTROLLED_PRODUCTION,
         AUTONOMOUS_INFLOW_CONTROL_VALVE,
+        DENSITY,
         DENSITY_ACTIVATED_RECOVERY,
+        INJECTION_VALVE,
         INFLOW_CONTROL_DEVICE,
         VALVE,
         INFLOW_CONTROL_VALVE,

completor/create_output.py

@@ -40,8 +40,9 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     print_inflow_control_valve = ""
     print_autonomous_inflow_control_device = ""
     print_inflow_control_device = ""
-    print_density_activated_recovery = ""
-    print_autonomous_inflow_control_valve = ""
+    print_density_driven = ""
+    print_injection_valve = ""
+    print_dual_rate_controlled_production = ""
 
     start_segment = 2
     start_branch = 1
@@ -110,10 +111,9 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
         df_autonomous_inflow_control_device = prepare_outputs.prepare_autonomous_inflow_control_device(
             well.well_name, lateral.df_well, lateral.df_device
         )
-        df_density_activated_recovery = prepare_outputs.prepare_density_activated_recovery(
-            well.well_name, lateral.df_well, lateral.df_device
-        )
-        df_autonomous_inflow_control_valve = prepare_outputs.prepare_autonomous_inflow_control_valve(
+        df_density_driven = prepare_outputs.prepare_density_driven(well.well_name, lateral.df_well, lateral.df_device)
+        df_injection_valve = prepare_outputs.prepare_injection_valve(well.well_name, lateral.df_well, lateral.df_device)
+        df_dual_rate_controlled_production = prepare_outputs.prepare_dual_rate_controlled_production(
             well.well_name, lateral.df_well, lateral.df_device
         )
         df_inflow_control_valve = prepare_outputs.prepare_inflow_control_valve(
@@ -147,11 +147,10 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
         print_inflow_control_valve += _format_inflow_control_valve(
             well.well_name, lateral.lateral_number, df_inflow_control_valve, first
         )
-        print_density_activated_recovery += _format_density_activated_recovery(
-            well.well_number, df_density_activated_recovery
-        )
-        print_autonomous_inflow_control_valve += _format_autonomous_inflow_control_valve(
-            well.well_number, df_autonomous_inflow_control_valve
+        print_density_driven += _format_density_driven(well.well_number, df_density_driven)
+        print_injection_valve += _format_injection_valve(well.well_number, df_injection_valve)
+        print_dual_rate_controlled_production += _format_dual_rate_controlled_production(
+            well.well_number, df_dual_rate_controlled_production
         )
 
         if figure_name is not None:
@@ -183,10 +182,10 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
         bonus.append(f"{Keywords.AUTONOMOUS_INFLOW_CONTROL_DEVICE}{print_autonomous_inflow_control_device}\n/\n\n\n")
     if print_inflow_control_valve:
         bonus.append(f"{Keywords.WELL_SEGMENTS_VALVE}{print_inflow_control_valve}\n/\n\n\n")
-    if print_density_activated_recovery:
+    if print_density_driven:
         metadata = (
             f"{'-' * 100}\n"
-            "-- This is how we model DAR technology using sets of ACTIONX keywords.\n"
+            "-- This is how we model DENSITY technology using sets of ACTIONX keywords.\n"
             "-- The segment dP curves changes according to the segment water-\n"
             "-- and gas volume fractions at downhole condition.\n"
             "-- The value of Cv is adjusted according to the segment length and the number of\n"
@@ -194,16 +193,26 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
             "-- volume fractions.\n"
             f"{'-' * 100}\n\n\n"
         )
-        bonus.append(metadata + print_density_activated_recovery + "\n\n\n\n")
-    if print_autonomous_inflow_control_valve:
+        bonus.append(metadata + print_density_driven + "\n\n\n\n")
+    if print_injection_valve:
         metadata = (
             f"{'-' * 100}\n"
-            "-- This is how we model AICV technology using sets of ACTIONX keyword\n"
+            "-- This is how we model INJV technology using sets of ACTIONX keywords.\n"
+            "-- The DP paramaters changes according to the trigger parameter.-\n"
+            "-- The value of Cv is adjusted according to the segment length and the number of\n"
+            "-- devices per joint. The constriction area will change if the parameter is triggered.\n"
+            f"{'-' * 100}\n\n\n"
+        )
+        bonus.append(metadata + print_injection_valve + "\n\n\n\n")
+    if print_dual_rate_controlled_production:
+        metadata = (
+            f"{'-' * 100}\n"
+            "-- This is how we model DUALRCP technology using sets of ACTIONX keyword\n"
             "-- the DP parameters change according to the segment water cut (at downhole condition )\n"
             "-- and gas volume fraction (at downhole condition)\n"
             f"{'-' * 100}\n\n\n"
         )
-        bonus.append(metadata + print_autonomous_inflow_control_valve + "\n\n\n\n")
+        bonus.append(metadata + print_dual_rate_controlled_production + "\n\n\n\n")
 
     return print_completion_data, print_well_segments, print_completion_segments, "".join(bonus)
 
@@ -439,34 +448,49 @@ def _format_inflow_control_valve(well_name: str, lateral_number: int, df_wsegicv
     )
 
 
-def _format_density_activated_recovery(well_number: int, df_wsegdar: pd.DataFrame) -> str:
-    """Formats well-segments for density activated recovery valve.
+def _format_density_driven(well_number: int, df_wsegdensity: pd.DataFrame) -> str:
+    """Formats well-segments for density driven valve.
+
+    Args:
+        well_number: The well's number
+        df_wsegdensity: Data to print.
+
+    Returns:
+        Formatted string.
+    """
+    if df_wsegdensity.empty:
+        return ""
+    return prepare_outputs.print_wsegdensity(df_wsegdensity, well_number + 1)
+
+
+def _format_injection_valve(well_number: int, df_wseginjv: pd.DataFrame) -> str:
+    """Formats well-segments for injection valve.
 
     Args:
         well_number: The well's number
-        df_wsegdar: Data to print.
+        df_wsegdinjv: Data to print.
 
     Returns:
         Formatted string.
     """
-    if df_wsegdar.empty:
+    if df_wseginjv.empty:
         return ""
-    return prepare_outputs.print_wsegdar(df_wsegdar, well_number + 1)
+    return prepare_outputs.print_wseginjv(df_wseginjv, well_number + 1)
 
 
-def _format_autonomous_inflow_control_valve(well_number: int, df_wsegaicv: pd.DataFrame) -> str:
-    """Formats the AICV section.
+def _format_dual_rate_controlled_production(well_number: int, df_wsegdualrcp: pd.DataFrame) -> str:
+    """Formats the DUALRCP section.
 
     Args:
         well_number: The well's number
-        df_wsegaicv: Data to print.
+        df_wsegdualrcp: Data to print.
 
     Returns:
         Formatted string.
     """
-    if df_wsegaicv.empty:
+    if df_wsegdualrcp.empty:
         return ""
-    return prepare_outputs.print_wsegaicv(df_wsegaicv, well_number + 1)
+    return prepare_outputs.print_wsegdualrcp(df_wsegdualrcp, well_number + 1)
 
 
 def _branch_revision(

completor/input_validation.py

@@ -173,7 +173,7 @@ def _check_for_errors(df_comp: pd.DataFrame, well_name: str, idx: int) -> None:
     if df_comp[Headers.DEVICE_TYPE].iloc[idx] not in Content.DEVICE_TYPES:
         raise CompletorError(
             f"{df_comp[Headers.DEVICE_TYPE].iloc[idx]} is not a valid device type. "
-            "Valid types are PERF, AICD, ICD, VALVE, DAR, AICV, and ICV."
+            "Valid types are PERF, AICD, ICD, VALVE, DENSITY, INJV, DUALRCP, and ICV."
         )
     if df_comp[Headers.ANNULUS].iloc[idx] not in Content.ANNULUS_TYPES:
         raise CompletorError(
@@ -181,6 +181,36 @@ def _check_for_errors(df_comp: pd.DataFrame, well_name: str, idx: int) -> None:
         )
 
 
+def set_density_based(df_comp: pd.DataFrame) -> pd.DataFrame:
+    """Set the column data format.
+    Args:
+        df_comp: Completion data.
+    Returns:
+        Updated device type to all density based.
+    """
+    df_comp[Headers.DEVICE_TYPE] = np.where(
+        df_comp[Headers.DEVICE_TYPE] == Content.DENSITY_ACTIVATED_RECOVERY,
+        Content.DENSITY,
+        df_comp[Headers.DEVICE_TYPE],
+    )
+    return df_comp
+
+
+def set_dualrcp(df_comp: pd.DataFrame) -> pd.DataFrame:
+    """Set the column data format.
+    Args:
+        df_comp: Completion data.
+    Returns:
+        Updated device type to all dual RCP based.
+    """
+    df_comp[Headers.DEVICE_TYPE] = np.where(
+        df_comp[Headers.DEVICE_TYPE] == Content.AUTONOMOUS_INFLOW_CONTROL_VALVE,
+        Content.DUAL_RATE_CONTROLLED_PRODUCTION,
+        df_comp[Headers.DEVICE_TYPE],
+    )
+    return df_comp
+
+
 def set_format_wsegvalv(df_temp: pd.DataFrame) -> pd.DataFrame:
     """Format the Well Segments Valve (WELSEGS) table.
 
@@ -242,11 +272,11 @@ def set_format_wsegaicd(df_temp: pd.DataFrame) -> pd.DataFrame:
     return df_temp
 
 
-def set_format_wsegdar(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments Density Activated Recovery (DAR) data.
+def set_format_wsegdensity(df_temp: pd.DataFrame) -> pd.DataFrame:
+    """Format the well segments Density Driven (DENSITY) data.
 
     Args:
-        df_temp: Well segments DAR device data.
+        df_temp: Well segments DENSITY device data.
 
     Returns:
         Updated data.
@@ -256,15 +286,34 @@ def set_format_wsegdar(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.DENSITY_ACTIVATED_RECOVERY))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.DENSITY))
+    return df_temp
+
+
+def set_format_wseginjv(df_temp: pd.DataFrame) -> pd.DataFrame:
+    """Format the well segments Injection Valve (INJV) data.
+
+    Args:
+        df_temp: Well segments INJV device data.
+
+    Returns:
+        Updated data.
+    """
+    df_temp[Headers.DEVICE_NUMBER] = df_temp[Headers.DEVICE_NUMBER].astype(np.int64)
+    # left out devicenumber and trigger parameter because devicenumber has been formatted as integer
+    # trigger parameter is a string
+    columns = df_temp.columns.to_numpy()[2:]
+    df_temp[columns] = df_temp[columns].astype(np.float64)
+    # Create ID device column
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.INJECTION_VALVE))
     return df_temp
 
 
-def set_format_wsegaicv(df_temp: pd.DataFrame) -> pd.DataFrame:
-    """Format the well segments Automatic Inflow Control Valve (AICV) table.
+def set_format_wsegdualrcp(df_temp: pd.DataFrame) -> pd.DataFrame:
+    """Format the well segments Dual RCP (DUALRCP) table.
 
     Args:
-        df_temp: Well segments automatic inflow control valve table.
+        df_temp: Well segments dual RCP table.
 
     Returns:
         Updated data.
@@ -274,7 +323,7 @@ def set_format_wsegaicv(df_temp: pd.DataFrame) -> pd.DataFrame:
     columns = df_temp.columns.to_numpy()[1:]
     df_temp[columns] = df_temp[columns].astype(np.float64)
     # Create ID device column
-    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.AUTONOMOUS_INFLOW_CONTROL_VALVE))
+    df_temp.insert(0, Headers.DEVICE_TYPE, np.full(df_temp.shape[0], Content.DUAL_RATE_CONTROLLED_PRODUCTION))
     return df_temp