completor 1.1.3__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`, `DENSITY`, `VALVE`, `DUALRCP`, `ICV`.
+        device_type: Device type. `AICD`, `ICD`, `DENSITY`, `VALVE`, `DUALRCP`, `ICV`, `INJV`.
 
     Returns:
         Updated well information with device characteristics.
@@ -581,6 +581,10 @@ 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.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]
     return df_well
 
 

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"
@@ -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"
@@ -245,6 +255,7 @@ class _Keywords:
     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"
@@ -290,6 +301,7 @@ class _Content:
     AUTONOMOUS_INFLOW_CONTROL_DEVICE = "AICD"
     DENSITY = "DENSITY"
     DENSITY_ACTIVATED_RECOVERY = "DAR"
+    INJECTION_VALVE = "INJV"
     VALVE = "VALVE"
     DEVICE_TYPES = [
         AUTONOMOUS_INFLOW_CONTROL_DEVICE,
@@ -297,6 +309,7 @@ class _Content:
         AUTONOMOUS_INFLOW_CONTROL_VALVE,
         DENSITY,
         DENSITY_ACTIVATED_RECOVERY,
+        INJECTION_VALVE,
         INFLOW_CONTROL_DEVICE,
         VALVE,
         INFLOW_CONTROL_VALVE,

completor/create_output.py

@@ -41,6 +41,7 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
     print_autonomous_inflow_control_device = ""
     print_inflow_control_device = ""
     print_density_driven = ""
+    print_injection_valve = ""
     print_dual_rate_controlled_production = ""
 
     start_segment = 2
@@ -111,6 +112,7 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
             well.well_name, lateral.df_well, lateral.df_device
         )
         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
         )
@@ -146,6 +148,7 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
             well.well_name, lateral.lateral_number, df_inflow_control_valve, first
         )
         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
         )
@@ -191,6 +194,16 @@ def format_output(well: Well, case: ReadCasefile, figure_name: str | None = None
             f"{'-' * 100}\n\n\n"
         )
         bonus.append(metadata + print_density_driven + "\n\n\n\n")
+    if print_injection_valve:
+        metadata = (
+            f"{'-' * 100}\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"
@@ -450,6 +463,21 @@ def _format_density_driven(well_number: int, df_wsegdensity: pd.DataFrame) -> st
     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_wsegdinjv: Data to print.
+
+    Returns:
+        Formatted string.
+    """
+    if df_wseginjv.empty:
+        return ""
+    return prepare_outputs.print_wseginjv(df_wseginjv, well_number + 1)
+
+
 def _format_dual_rate_controlled_production(well_number: int, df_wsegdualrcp: pd.DataFrame) -> str:
     """Formats the DUALRCP section.
 

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, DENSITY, DUALRCP, 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(
@@ -290,6 +290,25 @@ def set_format_wsegdensity(df_temp: pd.DataFrame) -> pd.DataFrame:
     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_wsegdualrcp(df_temp: pd.DataFrame) -> pd.DataFrame:
     """Format the well segments Dual RCP (DUALRCP) table.
 

completor/prepare_outputs.py

@@ -120,6 +120,7 @@ def dataframe_tostring(
             "END_MD": "{:.3f}".format,
             Headers.FLOW_COEFFICIENT: "{:.10g}".format,
             "CV": "{:.10g}".format,
+            Headers.CROSS: "{:.3e}".format,
             Headers.FLOW_CROSS_SECTIONAL_AREA: "{:.3e}".format,
             "FLOW_CROSS_SECTIONAL_AREA": "{:.3e}".format,
             Headers.OIL_FLOW_CROSS_SECTIONAL_AREA: "{:.3e}".format,
@@ -135,6 +136,13 @@ def dataframe_tostring(
             Headers.ALPHA_PILOT: "{:.10g}".format,
         }
 
+        # Cast floats to str befor headers are messed up (pandas formatter does not work reliably with MultiIndex headers).
+        for column, formatter in formatters.items():
+            try:
+                df_temp[column] = df_temp[column].map(formatter)
+            except (KeyError, ValueError):
+                pass
+
         if header:
             # Modify headers to reduce width.
             column_splits = [tuple(column.split("_")) for column in df_temp.columns]
@@ -173,9 +181,7 @@ def dataframe_tostring(
                 df_temp.columns = pd.MultiIndex.from_frame(new_cols)
 
     try:
-        output_string = df_temp.to_string(
-            index=False, justify="justify", formatters=formatters, header=header, sparsify=False
-        )
+        output_string = df_temp.to_string(index=False, justify="justify", header=header, sparsify=False)
     except ValueError:
         if df_temp.isnull().values.any():
             raise CompletorError("Got NaN values in table, please report if encountered!")
@@ -184,18 +190,14 @@ def dataframe_tostring(
         df_temp = df_temp.replace("1*", np.nan, inplace=False)
         # Probably find columns where this is the case and cast to numeric after replacing with nan?
         df_temp[columns_with_1_star] = df_temp[columns_with_1_star].astype(np.float64, errors="ignore")
-        output_string = df_temp.to_string(
-            index=False, justify="justify", formatters=formatters, header=header, sparsify=False, na_rep="1*"
-        )
+        output_string = df_temp.to_string(index=False, justify="justify", header=header, sparsify=False, na_rep="1*")
 
     if output_string is None:
         return ""
 
     too_long_lines = check_width_lines(output_string, limit)
     if too_long_lines:
-        output_string = df_temp.to_string(
-            index=False, justify="left", formatters=formatters, header=header, sparsify=False
-        )
+        output_string = df_temp.to_string(index=False, justify="left", header=header, sparsify=False)
         if output_string is None:
             return ""
         too_long_lines2 = check_width_lines(output_string, limit)
@@ -454,7 +456,11 @@ def prepare_device_layer(df_well: pd.DataFrame, df_tubing: pd.DataFrame, device_
                             df_well[Headers.DEVICE_TYPE] == Content.DUAL_RATE_CONTROLLED_PRODUCTION,
                             "/ -- DUALRCP types",
                             np.where(
-                                df_well[Headers.DEVICE_TYPE] == Content.INFLOW_CONTROL_VALVE, "/ -- ICV types", ""
+                                df_well[Headers.DEVICE_TYPE] == Content.INJECTION_VALVE,
+                                "/ -- INJV types",
+                                np.where(
+                                    df_well[Headers.DEVICE_TYPE] == Content.INFLOW_CONTROL_VALVE, "/ -- ICV types", ""
+                                ),
                             ),
                         ),
                     ),
@@ -1068,6 +1074,8 @@ def prepare_autonomous_inflow_control_device(
         wsegaicd[Headers.D] = df_merge[Headers.D].to_numpy()
         wsegaicd[Headers.E] = df_merge[Headers.E].to_numpy()
         wsegaicd[Headers.F] = df_merge[Headers.F].to_numpy()
+        if Headers.Z in df_merge.columns:
+            wsegaicd[Headers.Z] = df_merge[Headers.Z].to_numpy()
         wsegaicd[Headers.EMPTY] = "/"
     return wsegaicd
 
@@ -1303,6 +1311,48 @@ def prepare_density_driven(well_name: str, df_well: pd.DataFrame, df_device: pd.
     return wsegdensity
 
 
+def prepare_injection_valve(well_name: str, df_well: pd.DataFrame, df_device: pd.DataFrame) -> pd.DataFrame:
+    """Prepare data frame for INJECTION VALVE.
+
+    Args:
+        well_name: Well name.
+        df_well: Well data.
+        df_device: Device data for this well and lateral.
+
+    Returns:
+        DataFrame for INJECTION VALVE.
+    """
+    df_well = df_well[(df_well[Headers.DEVICE_TYPE] == Content.PERFORATED) | (df_well[Headers.NUMBER_OF_DEVICES] > 0)]
+    if df_well.shape[0] == 0:
+        return pd.DataFrame()
+    df_merge = pd.merge_asof(
+        left=df_device,
+        right=df_well,
+        left_on=[Headers.MEASURED_DEPTH],
+        right_on=[Headers.TUBING_MEASURED_DEPTH],
+        direction="nearest",
+    )
+    df_merge = df_merge[df_merge[Headers.DEVICE_TYPE] == Content.INJECTION_VALVE]
+    wseginjv = pd.DataFrame()
+    if df_merge.shape[0] > 0:
+        wseginjv[Headers.WELL] = [well_name] * df_merge.shape[0]
+        wseginjv[Headers.START_SEGMENT_NUMBER] = df_merge[Headers.START_SEGMENT_NUMBER].to_numpy()
+        # the Cv is already corrected by the scaling factor
+        wseginjv[Headers.FLOW_COEFFICIENT] = df_merge[Headers.FLOW_COEFFICIENT].to_numpy()
+        wseginjv[Headers.PRIMARY_FLOW_CROSS_SECTIONAL_AREA] = df_merge[
+            Headers.PRIMARY_FLOW_CROSS_SECTIONAL_AREA
+        ].to_numpy()
+        wseginjv[Headers.SECONDARY_FLOW_CROSS_SECTIONAL_AREA] = df_merge[
+            Headers.SECONDARY_FLOW_CROSS_SECTIONAL_AREA
+        ].to_numpy()
+        wseginjv[Headers.TRIGGER_PARAMETER] = df_merge[Headers.TRIGGER_PARAMETER].to_numpy()
+        wseginjv[Headers.TRIGGER_VALUE] = df_merge[Headers.TRIGGER_VALUE].to_numpy()
+        wseginjv[Headers.DEFAULTS] = "5*"
+        wseginjv[Headers.MAX_FLOW_CROSS_SECTIONAL_AREA] = wseginjv[Headers.PRIMARY_FLOW_CROSS_SECTIONAL_AREA].to_numpy()
+        wseginjv[Headers.EMPTY] = "/"
+    return wseginjv
+
+
 def prepare_dual_rate_controlled_production(
     well_name: str, df_well: pd.DataFrame, df_device: pd.DataFrame
 ) -> pd.DataFrame:
@@ -1513,6 +1563,168 @@ def print_wsegdensity(df_wsegdensity: pd.DataFrame, well_number: int) -> str:
     return action
 
 
+def print_wseginjv(df_wseginjv: pd.DataFrame, well_number: int) -> str:
+    """Print INJECTION VALVE devices.
+
+    Args:
+        df_wseginjv: Output from function prepare_wseginjv.
+        well_number: Well number.
+
+    Returns:
+        Formatted actions to be included in the output file.
+
+    Raises:
+        CompletorError: If there are to many wells and/or segments with INJECTION VALVE.
+    """
+    header = [
+        [
+            Headers.WELL,
+            Headers.START_SEGMENT_NUMBER,
+            Headers.FLOW_COEFFICIENT,
+            Headers.SECONDARY_FLOW_CROSS_SECTIONAL_AREA,
+            Headers.DEFAULTS,
+            Headers.MAX_FLOW_CROSS_SECTIONAL_AREA,
+        ],
+        [
+            Headers.WELL,
+            Headers.START_SEGMENT_NUMBER,
+            Headers.FLOW_COEFFICIENT,
+            Headers.PRIMARY_FLOW_CROSS_SECTIONAL_AREA,
+            Headers.DEFAULTS,
+            Headers.MAX_FLOW_CROSS_SECTIONAL_AREA,
+        ],
+    ]
+
+    sign = ["<", ">="]
+    suvtrig = ["0", "1"]
+    action = "UDQ\n"
+    for idx in range(df_wseginjv.shape[0]):
+        segment_number = df_wseginjv[Headers.START_SEGMENT_NUMBER].iloc[idx]
+        well_name = df_wseginjv[Headers.WELL].iloc[idx]
+        action += f"  ASSIGN SUVTRIG {well_name} {segment_number} 0 /\n"
+    action += "/\n\n"
+    iaction = 1
+    action += Keywords.WELL_SEGMENTS_VALVE + "\n"
+    header_string = "--"
+    for itm in header[iaction]:
+        header_string += "  " + itm
+    action += header_string.rstrip() + "\n"
+    for idx in range(df_wseginjv.shape[0]):
+        segment_number = df_wseginjv[Headers.START_SEGMENT_NUMBER].iloc[idx]
+        print_df = df_wseginjv[df_wseginjv[Headers.START_SEGMENT_NUMBER] == segment_number]
+        print_df = print_df[header[iaction]]
+        print_df = dataframe_tostring(print_df, True, False, False) + "\n"
+        action += print_df
+    action += "/\n\n"
+    for idx in range(df_wseginjv.shape[0]):
+        segment_number = df_wseginjv[Headers.START_SEGMENT_NUMBER].iloc[idx]
+        well_name = df_wseginjv[Headers.WELL].iloc[idx]
+        # Trigger paramater is segment water rate
+        if df_wseginjv[Headers.TRIGGER_PARAMETER].iloc[idx] == "SWFR":
+            water_segment_rate_cutoff = -1 * df_wseginjv[Headers.TRIGGER_VALUE].iloc[idx]
+            iaction = 0
+            act_number = iaction + 1
+            act_name = f"INJVOP{well_number:03d}{segment_number:03d}{act_number:1d}"
+            if len(act_name) > 13:
+                raise CompletorError("Too many wells and/or too many segments with Injection Valve")
+            action += (
+                f"ACTIONX\n{act_name} 1000000 /\n"
+                f"SWFR '{well_name}' {segment_number} "
+                f"{sign[iaction]} {water_segment_rate_cutoff} AND /\n"
+                f"SUVTRIG '{well_name}' {segment_number} "
+                f"= {suvtrig[iaction]} /\n/\n\n"
+            )
+            print_df = df_wseginjv[df_wseginjv[Headers.START_SEGMENT_NUMBER] == segment_number]
+            print_df = print_df[header[iaction]]  # type: ignore
+            header_string = Keywords.WELL_SEGMENTS_VALVE + "\n--"
+
+            for item in header[iaction]:
+                header_string += "  " + item
+            header_string = header_string.rstrip() + "\n"
+            print_df = header_string + dataframe_tostring(print_df, True, False, False)  # type: ignore
+            print_df += "\n/\n"
+            print_df += f"\nUDQ\n  ASSIGN SUVTRIG {well_name} {segment_number} 1 /\n/\n"
+            action += print_df + "\nENDACTIO\n\n"
+
+            iaction = 1
+            act_number = iaction + 1
+            act_name = f"INJVCL{well_number:03d}{segment_number:03d}{act_number:1d}"
+            if len(act_name) > 13:
+                raise CompletorError("Too many wells and/or too many segments with Injection Valve")
+            action += (
+                f"ACTIONX\n{act_name} 1000000 /\n"
+                f"SWFR '{well_name}' {segment_number} "
+                f"{sign[iaction]} {water_segment_rate_cutoff} AND /\n"
+                f"SUVTRIG '{well_name}' {segment_number} "
+                f"= {suvtrig[iaction]} /\n/\n\n"
+            )
+            print_df = df_wseginjv[df_wseginjv[Headers.START_SEGMENT_NUMBER] == segment_number]
+            print_df = print_df[header[iaction]]  # type: ignore
+            header_string = Keywords.WELL_SEGMENTS_VALVE + "\n--"
+
+            for item in header[iaction]:
+                header_string += "  " + item
+            header_string = header_string.rstrip() + "\n"
+            print_df = header_string + dataframe_tostring(print_df, True, False, False)  # type: ignore
+            print_df += "\n/\n"
+            print_df += f"\nUDQ\n  ASSIGN SUVTRIG {well_name} {segment_number} 0 /\n/\n"
+            action += print_df + "\nENDACTIO\n\n"
+
+        # Trigger parameter is segment pressure drop
+        elif df_wseginjv[Headers.TRIGGER_PARAMETER].iloc[idx] == "SPRD":
+            pressure_drop_cutoff = -1 * df_wseginjv[Headers.TRIGGER_VALUE].iloc[idx]
+            iaction = 0
+            act_number = iaction + 1
+            act_name = f"INJVOP{well_number:03d}{segment_number:03d}{act_number:1d}"
+            if len(act_name) > 13:
+                raise CompletorError("Too many wells and/or too many segments with Injection Valve")
+            action += (
+                f"ACTIONX\n{act_name} 1000000 /\n"
+                f"SPRD '{well_name}' {segment_number} "
+                f"{sign[iaction]} {pressure_drop_cutoff} AND /\n"
+                f"SUVTRIG '{well_name}' {segment_number} "
+                f"= {suvtrig[iaction]} /\n/\n\n"
+            )
+            print_df = df_wseginjv[df_wseginjv[Headers.START_SEGMENT_NUMBER] == segment_number]
+            print_df = print_df[header[iaction]]  # type: ignore
+            header_string = Keywords.WELL_SEGMENTS_VALVE + "\n--"
+
+            for item in header[iaction]:
+                header_string += "  " + item
+            header_string = header_string.rstrip() + "\n"
+            print_df = header_string + dataframe_tostring(print_df, True, False, False)  # type: ignore
+            print_df += "\n/\n"
+            print_df += f"\nUDQ\n  ASSIGN SUVTRIG {well_name} {segment_number} 1 /\n/\n"
+            action += print_df + "\nENDACTIO\n\n"
+
+            iaction = 1
+            act_number = iaction + 1
+            act_name = f"INJVCL{well_number:03d}{segment_number:03d}{act_number:1d}"
+            if len(act_name) > 13:
+                raise CompletorError("Too many wells and/or too many segments with Injection Valve")
+            action += (
+                f"ACTIONX\n{act_name} 1000000 /\n"
+                f"SPRD '{well_name}' {segment_number} "
+                f"{sign[iaction]} {pressure_drop_cutoff} AND /\n"
+                f"SUVTRIG '{well_name}' {segment_number} "
+                f"= {suvtrig[iaction]} /\n/\n\n"
+            )
+            print_df = df_wseginjv[df_wseginjv[Headers.START_SEGMENT_NUMBER] == segment_number]
+            print_df = print_df[header[iaction]]  # type: ignore
+            header_string = Keywords.WELL_SEGMENTS_VALVE + "\n--"
+
+            for item in header[iaction]:
+                header_string += "  " + item
+            header_string = header_string.rstrip() + "\n"
+            print_df = header_string + dataframe_tostring(print_df, True, False, False)  # type: ignore
+            print_df += "\n/\n"
+            print_df += f"\nUDQ\n  ASSIGN SUVTRIG {well_name} {segment_number} 0 /\n/\n"
+            action += print_df + "\nENDACTIO\n\n"
+        else:
+            raise CompletorError("Trigger paramater given is not supported")
+    return action
+
+
 def print_wsegdualrcp(df_wsegdualrcp: pd.DataFrame, well_number: int) -> str:
     """Print for DUALRCP devices.
 

completor/read_casefile.py

@@ -48,7 +48,7 @@ class ReadCasefile:
     This class reads the case/input file of the Completor program.
     It reads the following keywords:
     COMPLETION, SEGMENTLENGTH, JOINTLENGTH, AUTONOMOUS_INFLOW_CONTROL_DEVICE, WELL_SEGMENTS_VALVE,
-    INFLOW_CONTROL_DEVICE, DENSITY_DRIVEN, DUAL_RATE_CONTROLLED_PRODUCTION, INFLOW_CONTROL_VALVE.
+    INFLOW_CONTROL_DEVICE, DENSITY_DRIVEN, INJECTION_VALVE, DUAL_RATE_CONTROLLED_PRODUCTION, INFLOW_CONTROL_VALVE.
     In the absence of some keywords, the program uses the default values.
 
     Attributes:
@@ -64,6 +64,7 @@ class ReadCasefile:
         wsegvalv_table (pd.DataFrame): WELL_SEGMENTS_VALVE.
         wsegicv_table (pd.DataFrame): INFLOW_CONTROL_VALVE.
         wsegdensity_table (pd.DataFrame): DENSITY_DRIVEN.
+        wseginjv_table (pd.DataFrame): INJECTION_VALVE.
         wsegdualrcp_table (pd.DataFrame): DUAL_RATE_CONTROLLED_PRODUCTION.
         strict (bool): USE_STRICT. If TRUE it will exit if any lateral is not defined in the case-file. Default to TRUE.
         lat2device (pd.DataFrame): LATERAL_TO_DEVICE.
@@ -99,6 +100,7 @@ class ReadCasefile:
         self.wsegsicd_table = pd.DataFrame()
         self.wsegvalv_table = pd.DataFrame()
         self.wsegdensity_table = pd.DataFrame()
+        self.wseginjv_table = pd.DataFrame()
         self.wsegdualrcp_table = pd.DataFrame()
         self.wsegicv_table = pd.DataFrame()
         self.lat2device = pd.DataFrame()
@@ -117,6 +119,7 @@ class ReadCasefile:
         self.read_wsegvalv()
         self.read_wsegsicd()
         self.read_wsegdensity()
+        self.read_wseginjv()
         self.read_wsegdualrcp()
         self.read_wsegicv()
         self.read_lat2device()
@@ -449,10 +452,14 @@ class ReadCasefile:
                 Headers.F,
                 Headers.AICD_CALIBRATION_FLUID_DENSITY,
                 Headers.AICD_FLUID_VISCOSITY,
+                Headers.Z,
             ]
-            self.wsegaicd_table = input_validation.set_format_wsegaicd(
-                self._create_dataframe_with_columns(header, start_index, end_index)
-            )
+            try:
+                df_temp = self._create_dataframe_with_columns(header, start_index, end_index)
+            except CaseReaderFormatError:
+                header.remove(Headers.Z)
+                df_temp = self._create_dataframe_with_columns(header, start_index, end_index)
+            self.wsegaicd_table = input_validation.set_format_wsegaicd(df_temp)
             device_checks = self.completion_table[
                 self.completion_table[Headers.DEVICE_TYPE] == Content.AUTONOMOUS_INFLOW_CONTROL_DEVICE
             ][Headers.DEVICE_NUMBER].to_numpy()
@@ -514,6 +521,40 @@ class ReadCasefile:
             if not check_contents(device_checks, self.wsegdensity_table[Headers.DEVICE_NUMBER].to_numpy()):
                 raise CompletorError(f"Not all device in COMPLETION is specified in {key}")
 
+    def read_wseginjv(self) -> None:
+        """Read the INJECTION_VALVE keyword in the case file.
+
+        Raises:
+            CompletorError: If INJECTION_VALVE is not defined and INJV is used in COMPLETION,
+                or if the device number is not found.
+                If not all devices in COMPLETION are specified in INJECTION_VALVE.
+        """
+        start_index, end_index = parse.locate_keyword(self.content, Keywords.INJECTION_VALVE)
+        if start_index == end_index:
+            if Content.INJECTION_VALVE in self.completion_table[Headers.DEVICE_TYPE]:
+                raise CompletorError(
+                    f"{Keywords.INJECTION_VALVE} keyword must be defined, if INJV is used in the completion."
+                )
+        else:
+            # Table headers
+            header = [
+                Headers.DEVICE_NUMBER,
+                Headers.TRIGGER_PARAMETER,
+                Headers.TRIGGER_VALUE,
+                Headers.FLOW_COEFFICIENT,
+                Headers.PRIMARY_FLOW_CROSS_SECTIONAL_AREA,
+                Headers.SECONDARY_FLOW_CROSS_SECTIONAL_AREA,
+            ]
+            self.wseginjv_table = input_validation.set_format_wseginjv(
+                self._create_dataframe_with_columns(header, start_index, end_index)
+            )
+            # Check if the device in COMPLETION is exist in INJECTION_VALVE
+            device_checks = self.completion_table[
+                self.completion_table[Headers.DEVICE_TYPE] == Content.INJECTION_VALVE
+            ][Headers.DEVICE_NUMBER].to_numpy()
+            if not check_contents(device_checks, self.wseginjv_table[Headers.DEVICE_NUMBER].to_numpy()):
+                raise CompletorError(f"Not all device in COMPLETION is specified in {Keywords.INJECTION_VALVE}")
+
     def read_wsegdualrcp(self) -> None:
         """Read the DUALRCP keyword in the case file.
 

completor/utils.py

@@ -193,6 +193,7 @@ def get_active_wells(completion_table: pd.DataFrame, gp_perf_devicelayer: bool)
                 Content.AUTONOMOUS_INFLOW_CONTROL_DEVICE,
                 Content.DUAL_RATE_CONTROLLED_PRODUCTION,
                 Content.DENSITY,
+                Content.INJECTION_VALVE,
                 Content.INFLOW_CONTROL_DEVICE,
                 Content.VALVE,
                 Content.INFLOW_CONTROL_VALVE,

completor/visualize_well.py

@@ -48,6 +48,8 @@ def visualize_device(axs: Axes, df_well: pd.DataFrame) -> Axes:
             axs.plot(xpar, ypar, "rv-", markevery=[1])
         elif df_device[Headers.DEVICE_TYPE].iloc[idx] == Content.DENSITY:
             axs.plot(xpar, ypar, "rP-", markevery=[1])
+        elif df_device[Headers.DEVICE_TYPE].iloc[idx] == Content.INJECTION_VALVE:
+            axs.plot(xpar, ypar, "rP-", markevery=[1])
         elif df_device[Headers.DEVICE_TYPE].iloc[idx] == Content.DUAL_RATE_CONTROLLED_PRODUCTION:
             axs.plot(xpar, ypar, "r*-", markevery=[1])
     return axs

completor/wells.py

@@ -220,6 +220,8 @@ class Lateral:
             df_well = completion.get_device(df_well, case.wsegaicd_table, Content.AUTONOMOUS_INFLOW_CONTROL_DEVICE)
         if Content.DENSITY in active_devices:
             df_well = completion.get_device(df_well, case.wsegdensity_table, Content.DENSITY)
+        if Content.INJECTION_VALVE in active_devices:
+            df_well = completion.get_device(df_well, case.wseginjv_table, Content.INJECTION_VALVE)
         if Content.DUAL_RATE_CONTROLLED_PRODUCTION in active_devices:
             df_well = completion.get_device(df_well, case.wsegdualrcp_table, Content.DUAL_RATE_CONTROLLED_PRODUCTION)
         if Content.INFLOW_CONTROL_VALVE in active_devices:

{completor-1.1.3.dist-info → completor-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: completor
-Version: 1.1.3
+Version: 1.2.0
 Summary: Advanced multi-segmented well completion tool.
 Home-page: https://github.com/equinor/completor
 License: LGPL-3.0-only

{completor-1.1.3.dist-info → completor-1.2.0.dist-info}/RECORD

@@ -1,27 +1,27 @@
 completor/__init__.py,sha256=k6amf7jhp7KkBIlaw93-NZITxyZjPSzA5McFAZh8yv8,76
-completor/completion.py,sha256=--c2tN1ItE8r7YjxxOrTeZ71tz0KCVStxzWkjU-ERy4,30925
+completor/completion.py,sha256=quhQOdQREv8MsHW5amT0sG-84Y12KVdT0eylbKCul3g,31177
 completor/config_jobs/run_completor,sha256=XePKj2xocfGF0XFRqr7sqfpZGrjgWcfaZLHIhVvGFCQ,600
-completor/constants.py,sha256=N1u1SrsZap8hSvd4Cs9LCsNZBBIJy_3P2wd9djdTrgg,13028
-completor/create_output.py,sha256=T9W_uNdPzPkW1IyTAXWV38hF8ZvZs5ZrmrxvNHuS-mM,22909
+completor/constants.py,sha256=eZPe6cbP8see9f_sJdUkdy6J6HM2eXulgqRCzTCBAqY,13489
+completor/create_output.py,sha256=T0hPnCOns86q2lvRMNuOz8Nz-8zlliYBtxNiiEPMRWs,24101
 completor/exceptions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 completor/exceptions/clean_exceptions.py,sha256=uQ2jgGfvUDAoS56JBWh-8ZCPIMB4hvYxLF-snA-_-pg,373
 completor/exceptions/exceptions.py,sha256=eS00mVzmC4gQ7MUyGSknvKotmo2XzNGyp007mhjLMy0,5081
 completor/get_version.py,sha256=LMzybu7m-O203lUSZvyu86J4bMobbjE9A23fWLDlxaM,168
 completor/hook_implementations/jobs.py,sha256=8Ao8UadfJzEY7jWzj6C_OXm18fHmfXrbCB2_jS7KHiU,2180
-completor/input_validation.py,sha256=jNqYeAZFxrGJy5-xwK-n1Y0t9EKvJ12aA_z6yzN3N5E,14315
+completor/input_validation.py,sha256=F17AWi-qR6cX5_1lEFgtYOMOO0Xo3gTtL2ETM5P_uGE,15022
 completor/launch_args_parser.py,sha256=gb3FcyufZlRnKS3BZkFmgVH1VoSxMD0MbCLsHZKmz4c,1413
 completor/logger.py,sha256=gYDbPL8ca5qT_MqYlDKEMKcSfIXW_59QklX8Gss5b2U,4784
 completor/main.py,sha256=ipARMDXXqPYRtBxYQnlj5MohepwkgrQkX3s2IJEaEcI,9151
 completor/parse.py,sha256=EGlt9CgkrXPqa7woyWQ5t_nh6OWsFrc2SJr8aFr_KsQ,20133
-completor/prepare_outputs.py,sha256=GAQsRFrz7SwilExCq0w6f1tZE-4TmpHIeMS6_CwdbCM,72547
-completor/read_casefile.py,sha256=ToE7wGh0bKlS8hNFlRN21sPAufPuhRAvadkZGwB2ky4,35452
+completor/prepare_outputs.py,sha256=YS6p_kfTw_zXi0jKPwxrx45_54wrUaD0ryuZ2qe_S5Q,82582
+completor/read_casefile.py,sha256=qs39CkpwyNXV4cm0tpMi9NOyehBQKOBWmsCjSrWEauM,37578
 completor/read_schedule.py,sha256=IYyCubOggFGg664h1flTl7MUJhJWyibr6JsptnURjUA,18101
-completor/utils.py,sha256=ieqgLXfjbjDXHHSW283bliznj04Qep5KRUYGi_BXQRI,13557
+completor/utils.py,sha256=9Qayt7xMsimpoVDo5sL86gVaQBbIOezMBRyMXd3haXw,13598
 completor/visualization.py,sha256=ObxThqIyW3fsvVIupxVsgySFI_54n_Di-HTzFtDMSgo,4580
-completor/visualize_well.py,sha256=fkrjlEtSLsRrmSHoPYtCKIrCeEvXg4LsYyEEPryAB0I,8653
-completor/wells.py,sha256=GgZyfRa5wpSMIJUl5CPi5F1zdmU0XK6QjSduTzuh2NI,12093
-completor-1.1.3.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-completor-1.1.3.dist-info/METADATA,sha256=TAE2gJSk-z2H0sRan100EzToaDlrisCAdlo_jVOVFzA,7979
-completor-1.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-completor-1.1.3.dist-info/entry_points.txt,sha256=co5L2_CC2QQWVdEALeMp-NIC4mx4nRpcLcvpVXMYdeI,106
-completor-1.1.3.dist-info/RECORD,,
+completor/visualize_well.py,sha256=HLglSN2ce-u9nklJelqwhSxwwaj7n-aU6o8lUScbiI0,8790
+completor/wells.py,sha256=Q2detK0FxIBgusYkCRmomRIfcScBNvNTYX43GFyAHGw,12246
+completor-1.2.0.dist-info/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+completor-1.2.0.dist-info/METADATA,sha256=4C5L62K_4i2YRU-SuQxVlcStnd03iTd0bZzVscKJWTg,7979
+completor-1.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+completor-1.2.0.dist-info/entry_points.txt,sha256=co5L2_CC2QQWVdEALeMp-NIC4mx4nRpcLcvpVXMYdeI,106
+completor-1.2.0.dist-info/RECORD,,