Increase test coverage (#251)

Solve minor inconsistencies uncovered by added tests

Author: berland

pyscal/factory.py

@@ -226,10 +226,6 @@ def create_water_oil(params=None, fast=False):
                 "Added LET water to WaterOil object from parameters %s",
                 str(params_let_water.keys()),
             )
-        else:
-            logger.warning(
-                "Missing or ambiguous parameters for water curve in WaterOil object"
-            )
 
         # Oil curve:
         params_corey_oil = slicedict(params, WO_COREY_OIL + WO_OIL_ENDPOINTS)
@@ -269,10 +265,6 @@ def create_water_oil(params=None, fast=False):
                 "Added LET water to WaterOil object from parameters %s",
                 str(params_let_oil.keys()),
             )
-        else:
-            logger.warning(
-                "Missing or ambiguous parameters for oil curve in WaterOil object"
-            )
 
         # Capillary pressure:
         params_simple_j = slicedict(params, WO_SIMPLE_J + ["g"])
@@ -457,7 +449,7 @@ def create_water_oil_gas(params=None, fast=False):
         wateroilgas.gasoil = gasoil  # This might be None
         if not wateroilgas.selfcheck():
             raise ValueError(
-                ("Incomplete WaterOilGas object, some parameters missing to factory")
+                f"Inconsistent WaterOilGas object. Bug? Input was {params}"
             )
         return wateroilgas
 
@@ -616,7 +608,7 @@ def load_relperm_df(inputfile, sheet_name=None):
         Ensures case-insensitiveness SATNUM, CASE, TAG and COMMENT
 
         Merges COMMENT into TAG column, as only TAG is picked up downstream.
-        Adds a prexix "SATNUM <number>" to all tags.
+        Adds a prefix "SATNUM <number>" to all tags.
 
         All strings in CASE column are converted to lowercase. Applies
         aliasing in the CASE column so that "pessimistic" and "pess" map to
@@ -642,7 +634,7 @@ def load_relperm_df(inputfile, sheet_name=None):
                     "Sheet name only relevant for XLSX files, ignoring %s", sheet_name
                 )
             excel_engines = {"xls": "xlrd", "xlsx": "openpyxl"}
-            if sheet_name:
+            if tabular_file_format != "csv" and sheet_name:
                 try:
                     input_df = pd.read_excel(
                         inputfile,
@@ -655,10 +647,10 @@ def load_relperm_df(inputfile, sheet_name=None):
                         inputfile,
                         sheet_name,
                     )
-                except KeyError as error:
-                    logger.error("Non-existing sheet-name %s provided?", sheet_name)
-                    logger.error(str(error))
-                    return pd.DataFrame()
+                except (KeyError, ValueError) as error:
+                    raise ValueError(
+                        f"Non-existing sheet-name {sheet_name} provided."
+                    ) from error
             elif tabular_file_format.startswith("xls"):
                 input_df = pd.read_excel(
                     inputfile, engine=excel_engines[tabular_file_format]
@@ -738,10 +730,9 @@ def load_relperm_df(inputfile, sheet_name=None):
             raise ValueError("SATNUM must start at 1")
 
         if max(input_df["SATNUM"]) != len(input_df["SATNUM"].unique()):
-            logger.error(
+            raise ValueError(
                 "Missing SATNUMs? Max SATNUM is not equal to number of unique SATNUMS"
             )
-            raise ValueError
         if "CASE" not in input_df and len(input_df["SATNUM"].unique()) != len(input_df):
             raise ValueError("Non-unique SATNUMs?")
         # If we are in a SCAL recommendation setting
@@ -775,12 +766,9 @@ def load_relperm_df(inputfile, sheet_name=None):
         # Check that we are able to make something out of the first row:
         firstrow = input_df.iloc[0, :]
         error = False
-        try:
-            wo_ok = sufficient_water_oil_params(firstrow)
-            go_ok = sufficient_gas_oil_params(firstrow)
-            gw_ok = sufficient_gas_water_params(firstrow)
-        except ValueError:
-            error = True
+        wo_ok = sufficient_water_oil_params(firstrow)
+        go_ok = sufficient_gas_oil_params(firstrow)
+        gw_ok = sufficient_gas_water_params(firstrow)
         if error or not wo_ok and not go_ok and not gw_ok:
             raise ValueError(
                 "Can't make neither WaterOil, GasOil or GasWater from "

pyscal/gasoil.py

@@ -1,7 +1,6 @@
 """Representing a GasOil object"""
 
 import logging
-import warnings
 
 import numpy as np
 import pandas as pd
@@ -74,12 +73,7 @@ def __init__(
         assert -epsilon < sgcr < 1, "0 <= sgcr < 1 is required"
         assert -epsilon < swl < 1, "0 <= swl < 1 is required"
         assert -epsilon < sorg < 1, "0 <= sorg <  1 is required"
-        if not isinstance(tag, str):
-            warnings.warn(
-                "tag must be a string, this will be a hard failure later",
-                DeprecationWarning,
-            )
-            tag = ""
+
         if krgendanchor is None:
             krgendanchor = ""
 
@@ -638,13 +632,17 @@ def selfcheck(self, mode="SGOF"):
         if "krg" in self.table and not np.isclose(min(self.table["krg"]), 0.0):
             logger.error("krg must start at zero")
             error = True
-        if "pc" in self.table and self.table["pc"][0] > 0:
+        if "pc" in self.table and self.table["pc"][0] > -epsilon:
             if not (self.table["pc"].diff().dropna() < epsilon).all():
-                logger.error("pc data for gas-oil not strictly deceasing")
+                logger.error("pc data for gas-oil not strictly decreasing")
                 error = True
         if "pc" in self.table and np.isinf(self.table["pc"].max()):
             logger.error("pc goes to infinity for gas-oil. ")
             error = True
+        if "pc" in self.table.columns and np.isnan(self.table["pc"]).any():
+            logger.error("pc data contains NaN")
+            error = True
+
         for col in list(set(["sg", "krg", "krog"]) & set(self.table.columns)):
             if not (
                 (min(self.table[col]) >= -epsilon)
@@ -837,6 +835,9 @@ def SGFN(
                 string, overrides what this object can provide. Used by GasWater.
                 If None, it will be computed, use empty string to avoid.
         """
+        if not self.selfcheck(mode="SGFN"):
+            # Selfcheck will issue error messages.
+            return ""
         string = ""
         if "pc" not in self.table.columns:
             self.table["pc"] = 0.0

pyscal/wateroil.py

@@ -95,8 +95,6 @@ def __init__(
         if _sgcr is not None:
             self.sgcr = _sgcr
 
-        if not isinstance(tag, str):
-            tag = ""
         self.swirr = swirr
         self.swl = max(swl, swirr)  # Cannot allow swl < swirr. Warn?
         if not np.isclose(sorw, 0) and sorw < 1 / SWINTEGERS:
@@ -622,10 +620,9 @@ def add_simple_J(self, a=5, b=-1.5, poro_ref=0.25, perm_ref=100, drho=300, g=9.8
         assert perm_ref > 0.0
 
         if self.swl < epsilon:
-            logger.error(
-                "swl must larger than zero to avoid infinite capillary pressure"
+            raise ValueError(
+                "swl must be larger than zero to avoid infinite capillary pressure"
             )
-            raise ValueError
 
         if b > 0:
             logger.warning(
@@ -688,13 +685,12 @@ def add_simple_J_petro(self, a, b, poro_ref=0.25, perm_ref=100, drho=300, g=9.81
         assert perm_ref > 0.0
 
         if self.swl < epsilon:
-            logger.error(
-                "swl must larger than zero to avoid infinite capillary pressure"
+            raise ValueError(
+                "swl must be larger than zero to avoid infinite capillary pressure"
             )
-            raise ValueError
 
         if b > 0:
-            logger.warning(
+            raise ValueError(
                 "positive b will give increasing capillary pressure with saturation"
             )
 
@@ -743,8 +739,7 @@ def add_normalized_J(self, a, b, poro, perm, sigma_costau):
         assert isinstance(sigma_costau, (int, float))
 
         if b < 0 and np.isclose(self.swirr, self.swl):
-            logger.error("swl must be set larger than swirr to avoid infinite p_c")
-            raise ValueError("swl must be larger than swirr")
+            raise ValueError("swl must be larger than swirr to avoid infinite p_c")
 
         if abs(b) < 0.01:
             logger.warning(
@@ -794,36 +789,27 @@ def add_skjaeveland_pc(self, cw, co, aw, ao, swr=None, sor=None):
         Returns false if error occured.
 
         """  # noqa
-        inputerror = False  # Flag to be able to catch all errors
         if cw < 0:
-            logger.error("cw must be larger or equal to zero")
-            inputerror = True
+            raise ValueError("cw must be larger or equal to zero")
         if co > 0:
-            logger.error("co must be less than zero")
-            inputerror = True
+            raise ValueError("co must be less than zero")
         if aw <= 0:
-            logger.error("aw must be larger than zero")
-            inputerror = True
+            raise ValueError("aw must be larger than zero")
         if ao <= 0:
-            logger.error("ao must be larger than zero")
-            inputerror = True
+            raise ValueError("ao must be larger than zero")
 
         if swr is None:
             swr = self.swirr
         if sor is None:
             sor = self.sorw
 
         if swr >= 1 - sor:
-            logger.error("swr (swirr) must be less than 1 - sor")
-            inputerror = True
+            raise ValueError("swr (swirr) must be less than 1 - sor")
         if swr < 0 or swr > 1:
-            logger.error("swr must be contained in [0,1]")
-            inputerror = True
+            raise ValueError("swr must be contained in [0,1]")
         if sor < 0 or sor > 1:
-            logger.error("sor must be contained in [0,1]")
-            inputerror = True
-        if inputerror:
-            return
+            raise ValueError("sor must be contained in [0,1]")
+
         self.pccomment = (
             "-- Skjæveland correlation for Pc;\n"
             + "-- cw=%g, co=%g, aw=%g, ao=%g, swr=%g, sor=%g\n"
@@ -846,13 +832,9 @@ def add_skjaeveland_pc(self, cw, co, aw, ao, swr=None, sor=None):
             self.table["swnpc"] ** aw
         ) + co / (self.table["sonpc"] ** ao)
 
-        # From 1-sor, the pc is not defined. We want to extrapolate constantly,
-        # but with a twist as Eclipse does not non-monotone capillary pressure:
-        self.table["pc"].fillna(value=self.table["pc"].min(), inplace=True)
-        nanrows = self.table["sw"] > 1 - sor - epsilon
-        self.table.loc[nanrows, "pc"] = (
-            self.table.loc[nanrows, "pc"] - self.table.loc[nanrows, "sw"]
-        )  # Just deduct sw to make it monotone..
+        # From 1-sor, the pc is not defined. Extrapolate constantly, and let
+        # the non-monotonocity be fixed in the output generators.
+        self.table["pc"].fillna(method="ffill", inplace=True)
 
     def add_LET_pc_pd(self, Lp, Ep, Tp, Lt, Et, Tt, Pcmax, Pct):
         # pylint: disable=line-too-long
@@ -1046,6 +1028,9 @@ def selfcheck(self, mode="SWOF"):
             if not (self.table["pc"].diff().dropna().round(10) < epsilon).all():
                 logger.error("pc data not strictly decreasing")
                 error = True
+        if "pc" in self.table.columns and np.isnan(self.table["pc"]).any():
+            logger.error("pc data contains NaN")
+            error = True
         if "pc" in self.table.columns and np.isinf(self.table["pc"].max()):
             logger.error("pc goes to infinity. Maybe swirr=swl?")
             error = True

pyscal/wateroilgas.py

@@ -194,7 +194,7 @@ def SOF3(self, header=True, dataincommentrow=True):
         width = 10
         string += (
             "-- "
-            + "SW".ljust(width - 3)
+            + "SO".ljust(width - 3)
             + "KROW".ljust(width)
             + "KROG".ljust(width)
             + "\n"