def test_wateroil_krendmax(swl, swcr, sorw, kroend, kromax, krwend, krwmax, h, fast):
"""Test endpoints for wateroil using hypothesis testing"""
try:
wateroil = WaterOil(swl=swl, swcr=swcr, sorw=sorw, h=h, fast=fast)
except AssertionError:
return
kroend = min(kroend, kromax)
krwend = min(krwend, krwmax)
wateroil.add_corey_oil(kroend=kroend, kromax=kromax)
wateroil.add_corey_water(krwend=krwend, krwmax=krwmax)
check_table(wateroil.table)
assert wateroil.selfcheck()
assert 0 < wateroil.crosspoint() < 1
check_endpoints(wateroil, krwend, krwmax, kroend, kromax)
####################################
# Do it over again, but with LET:
wateroil.add_LET_oil(t=1.1, kroend=kroend, kromax=kromax)
wateroil.add_LET_water(t=1.1, krwend=krwend, krwmax=krwmax)
assert wateroil.selfcheck()
check_table(wateroil.table)
# Check endpoints for oil curve:
check_endpoints(wateroil, krwend, krwmax, kroend, kromax)
check_linear_sections(wateroil)
assert 0 < wateroil.crosspoint() < 1
def test_selfcheck(columnname, errorvalues):
"""Test the selfcheck feature of a WaterOil object"""
wateroil = WaterOil(h=1)
wateroil.add_corey_water()
wateroil.add_corey_oil()
assert wateroil.selfcheck()
# Punch the internal table directly to trigger error:
wateroil.table[columnname] = errorvalues
assert not wateroil.selfcheck()
assert wateroil.SWOF() == ""
if not columnname == "KROW":
assert wateroil.SWFN() == ""
def test_linear_input(h, sw_mid):
"""Linear input creates difficulties with sorw, which is used in
add_fromtable(). The intention of the test is to avoid crashes when
add_fromtable().
estimate_sorw() is unreliable on linear input, and returns 0 or 1 on the
given test dataset. Correctness of sorw should not be needed for
add_fromtable().
This tests fails in pyscal v0.7.7"""
dframe = pd.DataFrame(
columns=["SW", "KRW", "KROW", "PC"],
data=[[sw, sw, 1 - sw, 1 - sw] for sw in [0, sw_mid, 1.0]],
)
wateroil = WaterOil(h=h, swl=0)
wateroil.add_fromtable(dframe)
assert wateroil.selfcheck()
# GasOil did not fail in v0.7.7, but test anyway:
gasoil = GasOil(h=h, swl=0)
gasoil.add_fromtable(dframe,
sgcolname="SW",
krgcolname="KRW",
krogcolname="KROW",
pccolname="PCOW")
assert gasoil.selfcheck()
def test_wateroil_krendmax(swl, swcr, sorw, kroend, kromax, krwend, krwmax, h):
try:
wo = WaterOil(swl=swl, swcr=swcr, sorw=sorw, h=h)
except AssertionError:
return
kroend = min(kroend, kromax)
krwend = min(krwend, krwmax)
wo.add_corey_oil(kroend=kroend, kromax=kromax)
wo.add_corey_water(krwend=krwend, krwmax=krwmax)
check_table(wo.table)
assert wo.selfcheck()
check_endpoints(wo, krwend, krwmax, kroend, kromax)
####################################
# Do it over again, but with LET:
wo.add_LET_oil(kroend=kroend, kromax=kromax)
wo.add_LET_water(krwend=krwend, krwmax=krwmax)
assert wo.selfcheck()
check_table(wo.table)
# Check endpoints for oil curve:
check_endpoints(wo, krwend, krwmax, kroend, kromax)
def create_water_oil(params=None):
"""Create a WaterOil object from a dictionary of parameters.
Parameterization (Corey/LET) is inferred from presence
of certain parameters in the dictionary.
Don't rely on behaviour of you supply both Corey and LET at
the same time.
Parameter names in the dictionary are case insensitive. You
can use Swirr, swirr, sWirR, swiRR etc.
NB: the add_LET_* methods have the names 'l', 'e' and 't'
in their signatures, which is not precise enough in this
context, so we require e.g. 'Lw' and 'Low' (which both will be
translated to 'l')
Recognized parameters:
swirr, swl, swcr, sorw, h, tag, nw, now, krwmax, krwend,
lw, ew, tw, low, eow, tow, lo, eo, to, kromax, krowend,
a, a_petro, b, b_petro, poro_ref, perm_ref, drho,
a, b, poro, perm, sigma_costau
Args:
params (dict): Dictionary with parameters describing
the WaterOil object.
"""
if not params:
params = dict()
if not isinstance(params, dict):
raise TypeError(
"Parameter to create_water_oil must be a dictionary")
check_deprecated(params)
# For case insensitiveness, all keys are converted to lower case:
params = {key.lower(): value for (key, value) in params.items()}
# Allowing sending in NaN values, delete those keys.
params = filter_nan_from_dict(params)
usedparams = set()
# No requirements to the base objects, defaults are ok.
wateroil = WaterOil(**slicedict(params, WO_INIT))
usedparams = usedparams.union(set(slicedict(params, WO_INIT).keys()))
logger.info("Initialized WaterOil object from parameters %s",
str(list(usedparams)))
# Water curve
params_corey_water = slicedict(params,
WO_COREY_WATER + WO_WATER_ENDPOINTS)
params_let_water = slicedict(params, WO_LET_WATER + WO_WATER_ENDPOINTS)
if set(WO_COREY_WATER).issubset(set(params_corey_water)):
wateroil.add_corey_water(**params_corey_water)
usedparams = usedparams.union(set(params_corey_water.keys()))
logger.info(
"Added Corey water to WaterOil object from parameters %s",
str(params_corey_water.keys()),
)
elif set(WO_LET_WATER).issubset(set(params_let_water)):
params_let_water["l"] = params_let_water.pop("lw")
params_let_water["e"] = params_let_water.pop("ew")
params_let_water["t"] = params_let_water.pop("tw")
wateroil.add_LET_water(**params_let_water)
usedparams = usedparams.union(set(params_let_water.keys()))
logger.info(
"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)
params_let_oil = slicedict(
params, WO_LET_OIL + WO_LET_OIL_ALT + WO_OIL_ENDPOINTS)
if set(WO_COREY_OIL).issubset(set(params_corey_oil)):
if "krowend" in params_corey_oil:
params_corey_oil["kroend"] = params_corey_oil.pop("krowend")
wateroil.add_corey_oil(**params_corey_oil)
logger.info(
"Added Corey water to WaterOil object from parameters %s",
str(params_corey_oil.keys()),
)
elif set(WO_LET_OIL).issubset(set(params_let_oil)):
params_let_oil["l"] = params_let_oil.pop("low")
params_let_oil["e"] = params_let_oil.pop("eow")
params_let_oil["t"] = params_let_oil.pop("tow")
if "krowend" in params_let_oil:
params_let_oil["kroend"] = params_let_oil.pop("krowend")
wateroil.add_LET_oil(**params_let_oil)
logger.info(
"Added LET water to WaterOil object from parameters %s",
str(params_let_oil.keys()),
)
elif set(WO_LET_OIL_ALT).issubset(set(params_let_oil)):
params_let_oil["l"] = params_let_oil.pop("lo")
params_let_oil["e"] = params_let_oil.pop("eo")
params_let_oil["t"] = params_let_oil.pop("to")
if "krowend" in params_let_oil:
params_let_oil["kroend"] = params_let_oil.pop("krowend")
wateroil.add_LET_oil(**params_let_oil)
logger.info(
"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"])
params_norm_j = slicedict(params, WO_NORM_J)
params_simple_j_petro = slicedict(params, WO_SIMPLE_J_PETRO + ["g"])
if set(WO_SIMPLE_J).issubset(set(params_simple_j)):
wateroil.add_simple_J(**params_simple_j)
elif set(WO_SIMPLE_J_PETRO).issubset(set(params_simple_j_petro)):
params_simple_j_petro["a"] = params_simple_j_petro.pop("a_petro")
params_simple_j_petro["b"] = params_simple_j_petro.pop("b_petro")
wateroil.add_simple_J_petro(**params_simple_j_petro)
elif set(WO_NORM_J).issubset(set(params_norm_j)):
wateroil.add_normalized_J(**params_norm_j)
else:
logger.warning(
("Missing or ambiguous parameters for capillary pressure in "
"WaterOil object. Using zero."))
if not wateroil.selfcheck():
raise ValueError((
"Incomplete WaterOil object, some parameters missing to factory"
))
return wateroil
def create_water_oil(params=None):
"""Create a WaterOil object from a dictionary of parameters.
Parameterization (Corey/LET) is inferred from presence
of certain parameters in the dictionary.
Don't rely on behaviour of you supply both Corey and LET at
the same time.
Parameter names in the dictionary are case insensitive. You
can use Swirr, swirr, sWirR, swiRR etc.
NB: the add_LET_* methods have the names 'l', 'e' and 't'
in their signatures, which is not precise enough in this
context, so we require e.g. 'Lw' and 'Low' (which both will be
translated to 'l')
"""
if not params:
params = dict()
if not isinstance(params, dict):
raise TypeError(
"Parameter to create_water_oil must be a dictionary")
# For case insensitiveness, all keys are converted to lower case:
params = {key.lower(): value for (key, value) in params.items()}
usedparams = set()
# No requirements to the base objects, defaults are ok.
wateroil = WaterOil(**slicedict(params, WO_INIT))
usedparams = usedparams.union(set(slicedict(params, WO_INIT).keys()))
logging.info("Initialized WaterOil object from parameters %s",
str(list(usedparams)))
# Water curve
params_corey_water = slicedict(params,
WO_COREY_WATER + WO_WATER_ENDPOINTS)
params_let_water = slicedict(params, WO_LET_WATER + WO_WATER_ENDPOINTS)
if set(WO_COREY_WATER).issubset(set(params_corey_water)):
wateroil.add_corey_water(**params_corey_water)
usedparams = usedparams.union(set(params_corey_water.keys()))
logging.info(
"Added Corey water to WaterOil object from parameters %s",
str(params_corey_water.keys()),
)
elif set(WO_LET_WATER).issubset(set(params_let_water)):
params_let_water["l"] = params_let_water.pop("lw")
params_let_water["e"] = params_let_water.pop("ew")
params_let_water["t"] = params_let_water.pop("tw")
wateroil.add_LET_water(**params_let_water)
usedparams = usedparams.union(set(params_let_water.keys()))
logging.info(
"Added LET water to WaterOil object from parameters %s",
str(params_let_water.keys()),
)
else:
logging.warning(
"Missing or ambiguous parameters for water curve in WaterOil object"
)
# Oil curve:
params_corey_oil = slicedict(params, WO_COREY_OIL + WO_OIL_ENDPOINTS)
params_let_oil = slicedict(
params, WO_LET_OIL + WO_LET_OIL_ALT + WO_OIL_ENDPOINTS)
if set(WO_COREY_OIL).issubset(set(params_corey_oil)):
wateroil.add_corey_oil(**params_corey_oil)
logging.info(
"Added Corey water to WaterOil object from parameters %s",
str(params_corey_oil.keys()),
)
elif set(WO_LET_OIL).issubset(set(params_let_oil)):
params_let_oil["l"] = params_let_oil.pop("low")
params_let_oil["e"] = params_let_oil.pop("eow")
params_let_oil["t"] = params_let_oil.pop("tow")
wateroil.add_LET_oil(**params_let_oil)
logging.info(
"Added LET water to WaterOil object from parameters %s",
str(params_let_oil.keys()),
)
elif set(WO_LET_OIL_ALT).issubset(set(params_let_oil)):
params_let_oil["l"] = params_let_oil.pop("lo")
params_let_oil["e"] = params_let_oil.pop("eo")
params_let_oil["t"] = params_let_oil.pop("to")
wateroil.add_LET_oil(**params_let_oil)
logging.info(
"Added LET water to WaterOil object from parameters %s",
str(params_let_oil.keys()),
)
else:
logging.warning(
"Missing or ambiguous parameters for oil curve in WaterOil object"
)
# Capillary pressure:
params_simple_j = slicedict(params, WO_SIMPLE_J + ["g"])
params_norm_j = slicedict(params, WO_NORM_J)
if set(WO_SIMPLE_J).issubset(set(params_simple_j)):
wateroil.add_simple_J(**params_simple_j)
elif set(WO_NORM_J).issubset(set(params_norm_j)):
wateroil.add_normalized_J(**params_norm_j)
else:
logging.warning(
"Missing or ambiguous parameters for capillary pressure in WaterOil object. Using zero."
)
if not wateroil.selfcheck():
raise ValueError(("Incomplete WaterOil object, some parameters "
"missing to factory"))
return wateroil