completor 0.1.2__py3-none-any.whl → 1.0.0__py3-none-any.whl

completor/read_schedule.py

@@ -3,17 +3,17 @@ from __future__ import annotations
 import numpy as np
 import pandas as pd
 
-from completor.constants import Headers
+from completor.constants import Content, Headers, Keywords, ScheduleData, WellData
 from completor.logger import logger
 from completor.utils import sort_by_midpoint
 
 
 def fix_welsegs(df_header: pd.DataFrame, df_content: pd.DataFrame) -> tuple[pd.DataFrame, pd.DataFrame]:
-    """Convert a WELSEGS DataFrame specified in incremental (INC) to absolute (ABS) values.
+    """Convert a WELL_SEGMENTS DataFrame specified in incremental (INC) to absolute (ABS) values.
 
     Args:
-        df_header: First record table of WELSEGS.
-        df_content: Second record table of WELSEGS.
+        df_header: First record table of WELL_SEGMENTS.
+        df_content: Second record table of WELL_SEGMENTS.
 
     Returns:
         Updated header DataFrame, Updated content DataFrame.
@@ -24,12 +24,12 @@ def fix_welsegs(df_header: pd.DataFrame, df_content: pd.DataFrame) -> tuple[pd.D
     if df_header[Headers.INFO_TYPE].iloc[0] == "ABS":
         return df_header, df_content
 
-    ref_tvd = df_header[Headers.SEGMENTTVD].iloc[0]
-    ref_md = df_header[Headers.SEGMENTMD].iloc[0]
+    ref_tvd = df_header[Headers.TRUE_VERTICAL_DEPTH].iloc[0]
+    ref_md = df_header[Headers.MEASURED_DEPTH].iloc[0]
     inlet_segment = df_content[Headers.TUBING_SEGMENT].to_numpy()
     outlet_segment = df_content[Headers.TUBING_OUTLET].to_numpy()
-    md_inc = df_content[Headers.TUBING_MD].to_numpy()
-    tvd_inc = df_content[Headers.TUBING_TVD].to_numpy()
+    md_inc = df_content[Headers.TUBING_MEASURED_DEPTH].to_numpy()
+    tvd_inc = df_content[Headers.TRUE_VERTICAL_DEPTH].to_numpy()
     md_new = np.zeros(inlet_segment.shape[0])
     tvd_new = np.zeros(inlet_segment.shape[0])
 
@@ -44,8 +44,8 @@ def fix_welsegs(df_header: pd.DataFrame, df_content: pd.DataFrame) -> tuple[pd.D
 
     # update data frame
     df_header[Headers.INFO_TYPE] = ["ABS"]
-    df_content[Headers.TUBING_MD] = md_new
-    df_content[Headers.TUBING_TVD] = tvd_new
+    df_content[Headers.TUBING_MEASURED_DEPTH] = md_new
+    df_content[Headers.TRUE_VERTICAL_DEPTH] = tvd_new
     return df_header, df_content
 
 
@@ -54,7 +54,7 @@ def fix_compsegs(df_compsegs: pd.DataFrame, well_name: str) -> pd.DataFrame:
 
     The issue occurs when one cell is penetrated more than once by a well, and happens
     when there are big cells and the well path is complex.
-    The issue can be observed from a COMPSEGS definition that has overlapping start and end measured depth.
+    The issue can be observed from a COMPLETION_SEGMENTS definition that has overlapping start and end measured depth.
 
     Args:
         df_compsegs: DataFrame.
@@ -89,7 +89,11 @@ def fix_compsegs(df_compsegs: pd.DataFrame, well_name: str) -> pd.DataFrame:
                 start_md_new[idx] = start_md[idx]
                 end_md_new[idx] = end_md[idx]
             else:
-                logger.info("Overlapping in COMPSEGS for %s. Sorts the depths accordingly", well_name)
+                logger.info(
+                    "Overlapping in COMPLETION_SEGMENTS%s for %s. Sorts the depths accordingly",
+                    Keywords.COMPLETION_SEGMENTS,
+                    well_name,
+                )
                 comb_depth = np.append(start_md, end_md)
                 comb_depth = np.sort(comb_depth)
                 start_md_new = np.copy(comb_depth[::2])
@@ -107,7 +111,10 @@ def fix_compsegs(df_compsegs: pd.DataFrame, well_name: str) -> pd.DataFrame:
             if start_md_new[idx] >= end_md_new[idx - 1]:
                 start_md_new[idx] = end_md_new[idx - 1]
             else:
-                logger.error("Cannot construct COMPSEGS segments based on current input")
+                logger.error(
+                    "Cannot construct COMPLETION_SEGMENTS%s segments based on current input",
+                    Keywords.COMPLETION_SEGMENTS,
+                )
     return sort_by_midpoint(df_compsegs, start_md_new, end_md_new)
 
 
@@ -126,7 +133,8 @@ def fix_compsegs_by_priority(
     """
     # slicing two dataframe for user and cells segment length
     start_md_comp = df_completion[
-        (df_completion[Headers.DEVICE_TYPE] == "ICV") & (df_completion[Headers.VALVES_PER_JOINT] > 0)
+        (df_completion[Headers.DEVICE_TYPE] == Content.INFLOW_CONTROL_VALVE)
+        & (df_completion[Headers.VALVES_PER_JOINT] > 0)
     ][Headers.START_MEASURED_DEPTH].reset_index(drop=True)
     df_custom_compsegs = df_custom_compsegs[df_custom_compsegs[Headers.START_MEASURED_DEPTH].isin(start_md_comp)]
     df_compsegs["priority"] = 1
@@ -158,3 +166,298 @@ def fix_compsegs_by_priority(
     df = df.dropna()
 
     return df.drop("priority", axis=1)
+
+
+def set_welspecs(schedule_data: ScheduleData, records: list[list[str]]) -> ScheduleData:
+    """Convert the well specifications (WELSPECS) record to a Pandas DataFrame.
+
+    * Sets DataFrame column titles.
+    * Formats column values.
+    * Pads missing columns at the end of the DataFrame with default values (1*).
+
+    Args:
+        schedule_data: Data containing multisegmented well schedules.
+        records: Raw well specification.
+
+    Returns:
+        Multisegmented wells with updated welspecs records.
+    """
+    columns = [
+        Headers.WELL,
+        Headers.GROUP,
+        Headers.I,
+        Headers.J,
+        Headers.BHP_DEPTH,
+        Headers.PHASE,
+        Headers.DR,
+        Headers.FLAG,
+        Headers.SHUT,
+        Headers.FLOW_CROSS_SECTIONAL_AREA,
+        Headers.PRESSURE_TABLE,
+        Headers.DENSITY_CALCULATION_TYPE,
+        Headers.REGION,
+        Headers.RESERVED_HEADER_1,
+        Headers.RESERVED_HEADER_2,
+        Headers.WELL_MODEL_TYPE,
+        Headers.POLYMER_MIXING_TABLE_NUMBER,
+    ]
+    len_to_pad = len(columns) - len(records[0])
+    _records = [rec + ["1*"] * len_to_pad for rec in records]  # pad with default values (1*)
+    df = pd.DataFrame(_records, columns=columns)
+    df[columns[2:4]] = df[columns[2:4]].astype(np.int64)
+    df[columns[4]] = df[columns[4]].astype(np.float64, errors="ignore")
+    # welspecs could be for multiple wells - split it
+    for well_name in df[Headers.WELL].unique():
+        if well_name not in schedule_data:
+            schedule_data[well_name] = {}
+        schedule_data[well_name][Keywords.WELL_SPECIFICATION] = df[df[Headers.WELL] == well_name]
+        logger.debug("set_welspecs for %s", well_name)
+    return schedule_data
+
+
+def set_welsegs(schedule_data: ScheduleData, recs: list[list[str]]) -> ScheduleData:
+    """Update the well segments (WELSEGS) for a given well if it is an active well.
+
+    * Pads missing record columns in header and contents with default values.
+    * Convert header and column records to DataFrames.
+    * Sets proper DataFrame column types and titles.
+    * Converts segment depth specified in incremental (INC) to absolute (ABS) values using fix_welsegs.
+
+    Args:
+        schedule_data: Data containing multisegmented well schedules.
+        recs: Record set of header and contents data.
+
+    Returns:
+        Name of well if it was updated, or None if it is not in the active_wells list.
+
+    Raises:
+        ValueError: If a well is not an active well.
+    """
+    well_name = recs[0][0]  # each WELL_SEGMENTS-chunk is for one well only
+    columns_header = [
+        Headers.WELL,
+        Headers.TRUE_VERTICAL_DEPTH,
+        Headers.MEASURED_DEPTH,
+        Headers.WELLBORE_VOLUME,
+        Headers.INFO_TYPE,
+        Headers.PRESSURE_DROP_COMPLETION,
+        Headers.MULTIPHASE_FLOW_MODEL,
+        Headers.X_COORDINATE_TOP_SEGMENT,
+        Headers.Y_COORDINATE_TOP_SEGMENT,
+        Headers.THERMAL_CONDUCTIVITY_CROSS_SECTIONAL_AREA,
+        Headers.VOLUMETRIC_HEAT_CAPACITY_PIPE_WALL,
+        Headers.THERMAL_CONDUCTIVITY_PIPE_WALL,
+    ]
+    # pad header with default values (1*)
+    header = recs[0] + ["1*"] * (len(columns_header) - len(recs[0]))
+    df_header = pd.DataFrame(np.array(header).reshape((1, len(columns_header))), columns=columns_header)
+    df_header[columns_header[1:3]] = df_header[columns_header[1:3]].astype(np.float64)  # data types
+
+    # make df for data records
+    columns_data = [
+        Headers.TUBING_SEGMENT,
+        Headers.TUBING_SEGMENT_2,
+        Headers.TUBING_BRANCH,
+        Headers.TUBING_OUTLET,
+        Headers.TUBING_MEASURED_DEPTH,
+        Headers.TRUE_VERTICAL_DEPTH,
+        Headers.TUBING_INNER_DIAMETER,
+        Headers.TUBING_ROUGHNESS,
+        Headers.FLOW_CROSS_SECTIONAL_AREA,
+        Headers.SEGMENT_VOLUME,
+        Headers.X_COORDINATE_LAST_SEGMENT,
+        Headers.Y_COORDINATE_LAST_SEGMENT,
+        Headers.THERMAL_CONDUCTIVITY_CROSS_SECTIONAL_AREA,
+        Headers.VOLUMETRIC_HEAT_CAPACITY_PIPE_WALL,
+        Headers.THERMAL_CONDUCTIVITY_PIPE_WALL,
+    ]
+    # pad with default values (1*)
+    recs = [rec + ["1*"] * (len(columns_data) - len(rec)) for rec in recs[1:]]
+    df_records = pd.DataFrame(recs, columns=columns_data)
+    # data types
+    df_records[columns_data[:4]] = df_records[columns_data[:4]].astype(np.int64)
+    df_records[columns_data[4:8]] = df_records[columns_data[4:8]].astype(np.float64)
+    # fix abs/inc issue with welsegs
+    df_header, df_records = fix_welsegs(df_header, df_records)
+
+    # Warn user if the tubing segments' measured depth for a branch
+    # is not sorted in ascending order (monotonic)
+    for branch_num in df_records[Headers.TUBING_BRANCH].unique():
+        if (
+            not df_records[Headers.TUBING_MEASURED_DEPTH]
+            .loc[df_records[Headers.TUBING_BRANCH] == branch_num]
+            .is_monotonic_increasing
+        ):
+            logger.warning(
+                "The branch %s in well %s contains negative length segments. Check the input schedulefile %s "
+                "keyword for inconsistencies in measured depth (MEASURED_DEPTH) of Tubing layer.",
+                Keywords.WELL_SEGMENTS,
+                branch_num,
+                well_name,
+            )
+
+    if well_name not in schedule_data:
+        schedule_data[well_name] = {}
+    schedule_data[well_name][Keywords.WELL_SEGMENTS] = df_header, df_records
+    return schedule_data
+
+
+def set_compsegs(schedule_data: ScheduleData, recs: list[list[str]]) -> ScheduleData:
+    """Update COMPLETION_SEGMENTS for a well if it is an active well.
+
+    * Pads missing record columns in header and contents with default 1*.
+    * Convert header and column records to DataFrames.
+    * Sets proper DataFrame column types and titles.
+
+    Args:
+        schedule_data: Data containing multisegmented well schedules.
+        recs: Record set of header and contents data.
+
+    Returns:
+        The updated well segments.
+
+    Raises:
+        ValueError: If a well is not an active well.
+    """
+    well_name = recs[0][0]  # each COMPLETION_SEGMENTS-chunk is for one well only
+    columns = [
+        Headers.I,
+        Headers.J,
+        Headers.K,
+        Headers.BRANCH,
+        Headers.START_MEASURED_DEPTH,
+        Headers.END_MEASURED_DEPTH,
+        Headers.COMPSEGS_DIRECTION,
+        Headers.ENDGRID,
+        Headers.PERFORATION_DEPTH,
+        Headers.THERMAL_CONTACT_LENGTH,
+        Headers.SEGMENT,
+    ]
+    recs = np.array(recs[1:])
+    recs = np.pad(recs, ((0, 0), (0, len(columns) - recs.shape[1])), "constant", constant_values="1*")
+    df = pd.DataFrame(recs, columns=columns)
+    df[columns[:4]] = df[columns[:4]].astype(np.int64)
+    df[columns[4:6]] = df[columns[4:6]].astype(np.float64)
+    if well_name not in schedule_data:
+        schedule_data[well_name] = {}
+    schedule_data[well_name][Keywords.COMPLETION_SEGMENTS] = df
+    logger.debug("set_compsegs for %s", well_name)
+    return schedule_data
+
+
+def set_compdat(schedule_data: ScheduleData, records: list[list[str]]) -> ScheduleData:
+    """Convert completion data (COMPDAT) record to a DataFrame.
+
+    * Sets DataFrame column titles.
+    * Pads missing values with default values (1*).
+    * Sets column data types.
+
+    Args:
+        schedule_data: Data containing multisegmented well schedules.
+        records: Record set of COMPLETION_DATA data.
+
+    Returns:
+        Key (well name), subkey (keyword), data (DataFrame).
+    """
+    columns = [
+        Headers.WELL,
+        Headers.I,
+        Headers.J,
+        Headers.K,
+        Headers.K2,
+        Headers.STATUS,
+        Headers.SATURATION_FUNCTION_REGION_NUMBERS,
+        Headers.CONNECTION_FACTOR,
+        Headers.WELL_BORE_DIAMETER,
+        Headers.FORMATION_PERMEABILITY_THICKNESS,
+        Headers.SKIN,
+        Headers.D_FACTOR,
+        Headers.COMPDAT_DIRECTION,
+        Headers.RO,
+    ]
+    df = pd.DataFrame(records, columns=columns[0 : len(records[0])])
+    if Headers.RO in df.columns:
+        df[Headers.RO] = df[Headers.RO].fillna("1*")
+    for i in range(len(records[0]), len(columns)):
+        df[columns[i]] = ["1*"] * len(records)
+    df[columns[1:5]] = df[columns[1:5]].astype(np.int64)
+    # Change default value '1*' to equivalent float
+    df["SKIN"] = df["SKIN"].replace(["1*"], 0.0)
+    df[[Headers.WELL_BORE_DIAMETER, Headers.SKIN]] = df[[Headers.WELL_BORE_DIAMETER, Headers.SKIN]].astype(np.float64)
+    # check if CONNECTION_FACTOR, FORMATION_PERMEABILITY_THICKNESS, and RO are defaulted by the users
+    df = df.astype(
+        {
+            Headers.CONNECTION_FACTOR: np.float64,
+            Headers.FORMATION_PERMEABILITY_THICKNESS: np.float64,
+            Headers.RO: np.float64,
+        },
+        errors="ignore",
+    )
+    # Compdat could be for multiple wells, split it.
+    unique_wells = df[Headers.WELL].unique()
+    for well_name in unique_wells:
+        if well_name not in schedule_data:
+            schedule_data[well_name] = {}
+        schedule_data[well_name][Keywords.COMPLETION_DATA] = df[df[Headers.WELL] == well_name]
+        logger.debug("handle_compdat for %s", well_name)
+    return schedule_data
+
+
+def get_completion_data(well_data: WellData) -> pd.DataFrame:
+    """Get-function for COMPLETION_DATA.
+
+    Args:
+        well_data: Segment information.
+
+    Returns:
+        Completion data.
+
+    Raises:
+        ValueError: If completion data keyword is missing in input schedule file.
+    """
+    data = well_data.get(Keywords.COMPLETION_DATA)
+    if data is None:
+        raise KeyError(f"Input schedule file missing {Keywords.COMPLETION_DATA} keyword.")
+    return data  # type: ignore # TODO(#173): Use TypedDict for WellData.
+
+
+def get_completion_segments(well_data: WellData, well_name: str, branch: int | None = None) -> pd.DataFrame:
+    """Get-function for COMPLETION_SEGMENTS.
+
+    Args:
+       well_data: Data containing multisegmented well segments.
+       well_name: Well name.
+       branch: Branch number.
+
+    Returns:
+        Completion segment data.
+    """
+    df = well_data[Keywords.COMPLETION_SEGMENTS].copy()  # type: ignore # TODO(#173): Use TypedDict for WellData.
+    if branch is not None:
+        df = df[df[Headers.BRANCH] == branch]
+    df = df.reset_index(drop=True)  # reset index after filtering
+    return fix_compsegs(df, well_name)
+
+
+def get_well_segments(well_data: WellData, branch: int | None = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+    """Get-function for well segments.
+
+    Args:
+        well_data: The multisegmented wells.
+        branch: Branch number.
+
+    Returns:
+        Well segments headers and content.
+
+    Raises:
+        ValueError: If WELL_SEGMENTS keyword missing in input schedule file.
+    """
+    data = well_data.get(Keywords.WELL_SEGMENTS)
+    if data is None:
+        raise ValueError(f"Input schedule file missing {Keywords.WELL_SEGMENTS} keyword.")
+    columns, content = data
+
+    if branch is not None:
+        content = content[content[Headers.TUBING_BRANCH] == branch]
+    content = content.reset_index(drop=True)
+    return columns, content