rock-physics-open 0.0__py3-none-any.whl

rock_physics_open/fluid_models/oil_model/dead_oil_density.py

@@ -0,0 +1,60 @@
+import numpy as np
+
+
+def pressure_adjusted_dead_oil_density(
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Adjusts density of a dead oil (without dissolved gas) to a given pressure.
+
+    Uses equation 18 from Batzle & Wang [1].
+
+    :param reference_density: The density (g/cc) of the dead oil at 15.6 degrees Celsius
+        and atmospheric pressure.
+    :param pressure: Pressure (MPa) to adjust to.
+    :return: Density of oil at given pressure and 21 degrees Celsius (~70 degrees
+    Farenheit).
+    """
+    return (
+        reference_density
+        + (0.00277 * pressure - 1.71 * 10**-7 * pressure**3)
+        * (reference_density - 1.15) ** 2
+        + 3.49 * 10**-4 * pressure
+    )
+
+
+def temperature_adjusted_dead_oil_density(
+    temperature: np.ndarray | float,
+    density_at_21c: np.ndarray,
+) -> np.ndarray | float:
+    """
+    Adjusts density of a dead oil (without dissolved gas) to a given temperature.
+
+    Uses equation 19 from Batzle & Wang [1].
+
+    :param density_at_21c: The density (g/cc) of the dead oil at 21 degrees Celsius
+    :param temperature: Temperature (Celsius) of oil.
+    :return: Density of oil at given temperature.
+    """
+    return density_at_21c / (0.972 + 3.81 * (10**-4) * (temperature + 17.78) ** 1.175)
+
+
+def dead_oil_density(
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    The density of oil without dissolved gas (dead).
+
+    Uses equation 18 & 19 from Batzle & Wang [1].
+
+    :param reference_density: Density of oil at 15.6 degrees Celsius and atmospheric
+        pressure. (g/cc)
+    :param pressure: Pressure (MPa) of oil
+    :param temperature: Temperature (Celsius) of oil.
+    :return: density of dead oil at given conditions.
+    """
+    density_p = pressure_adjusted_dead_oil_density(pressure, reference_density)
+    return temperature_adjusted_dead_oil_density(temperature, density_p)

rock_physics_open/fluid_models/oil_model/dead_oil_velocity.py

@@ -0,0 +1,28 @@
+import numpy as np
+
+
+def dead_oil_velocity(
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    The primary wave velocity in oil without dissolved gas (dead).
+
+    Uses equation 20a from Batzle & Wang [1].
+
+    :param reference_density: Density of oil at 15.6 degrees Celsius and atmospheric
+        pressure (g/cc)
+    :param pressure: Pressure (MPa) of oil
+    :param temperature: Temperature (Celsius) of oil.
+    :return: primary velocity of dead oil in m/s.
+    """
+    return (
+        2096 * np.sqrt(reference_density / (2.6 - reference_density))
+        - 3.7 * temperature
+        + 4.64 * pressure
+        + 0.0115
+        * (4.12 * np.sqrt(1.08 * reference_density**-1 - 1) - 1)
+        * temperature
+        * pressure
+    )

rock_physics_open/fluid_models/oil_model/live_oil_density.py

@@ -0,0 +1,79 @@
+import numpy as np
+
+
+def live_oil_density(
+    temperature,
+    pressure: np.ndarray | float | None,
+    reference_density: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Density of live oil at saturation.
+
+    Equation 24 in Batzle & Wang [1].
+
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. (g/cc)
+    :param pressure: Pressure (MPa) of oil (for future implementation only)
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param temperature: Temperature (Celsius) of oil.
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :return: Density of live oil [g/cc].
+    """
+    b0 = live_oil_volume_factor(
+        temperature, reference_density, gas_oil_ratio, gas_gravity
+    )
+    return (reference_density + 0.0012 * gas_gravity * gas_oil_ratio) / b0
+
+
+def live_oil_pseudo_density(
+    temperature: np.ndarray | float,
+    reference_density: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Pseudo density used to substitute reference density in dead_oil_wave_velocity
+    for live oils.
+
+    Equation 22 in Batzle & Wang [1].
+
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. (g/cc)
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param temperature: Temperature (Celsius) of oil.
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :return: Pseudo-density of live oil.
+    """
+    b0 = live_oil_volume_factor(
+        temperature, reference_density, gas_oil_ratio, gas_gravity
+    )
+    return (reference_density / b0) / (1 + 0.001 * gas_oil_ratio)
+
+
+def live_oil_volume_factor(
+    temperature: np.ndarray | float,
+    reference_density: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Volume factor derived by Standing (1962), equation 23 in Batzle & Wang [1].
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. (g/cc)
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param temperature: Temperature (Celsius) of oil.
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :return: A volume factor in calculating pseudo-density of live oil.
+    """
+    return (
+        0.972
+        + 0.00038
+        * (
+            2.4 * gas_oil_ratio * np.sqrt(gas_gravity / reference_density)
+            + temperature
+            + 17.8
+        )
+        ** 1.175
+    )

rock_physics_open/fluid_models/oil_model/live_oil_velocity.py

@@ -0,0 +1,24 @@
+from .dead_oil_velocity import dead_oil_velocity
+from .live_oil_density import live_oil_pseudo_density
+
+
+def live_oil_velocity(
+    temperature, pressure, reference_density, gas_oil_ratio, gas_gravity
+):
+    """
+    Primary wave velocity of live oil at saturation.
+
+    Substitute Equation 22 in Equation 20 of Batzle & Wang [1].
+
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. (g/cc)
+    :param pressure: Pressure (MPa) of oil
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param temperature: Temperature (Celsius) of oil.
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :return: Primary wave velocity of live oil [m/s].
+    """
+    rho_marked = live_oil_pseudo_density(
+        temperature, reference_density, gas_oil_ratio, gas_gravity
+    )
+    return dead_oil_velocity(temperature, pressure, rho_marked)

rock_physics_open/fluid_models/oil_model/oil_bubble_point.py

@@ -0,0 +1,69 @@
+import numpy as np
+
+
+def bp_standing(
+    density: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
+    temperature: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    Reservoir oils include some natural gas in solution. The pressure at which
+    this natural gas begins to come out of solution and form bubbles is known
+    as the bubble point pressure. See https://petrowiki.org/Oil_bubblepoint_pressure
+    Based on the correlation from:
+    Standing, M. B. "A pressure-volume-temperature correlation for mixtures of
+    California oils and gases." Drilling and Production Practice. American
+    Petroleum Institute, 1947.
+    Uses refinment described here: https://petrowiki.org/Oil_bubblepoint_pressure
+    :param density: density of oil at room conditions [kg/m^3]
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :param temperature: temperature of oil [°C]
+    :return: bubble point pressure [Pa]
+    """
+
+    # Standing, M.B. (1947) uses:
+    # * pressure in psi
+    # * temperature in F
+    # * gas oil ratio in cu ft per bbl
+    # * bubble point in in absolute psi
+    # * gravity_of_tank_oil in API
+    #
+    # The paper describes that bubble point is a function of
+    # (gor / gr) ** 0.83
+    #   * (10**(0.00091 * t)/10**(0.0125*gravity_of_tank_oil))
+    #
+    # and gives the following example:
+    #   Bubble point pressure at 200° F
+    #   of a liquid having gas-oil ratio
+    #   350 CFB, a gas gravity 0.75, and
+    #   a tank oil gravity of 30° API.
+    #   The required pressure is found
+    #   to be 1930 psia.
+    #
+    # We could scale to fit this example, however,
+    # we use 1896 psia.
+    #
+    # For density in kg/m^3:
+    # 10**(0.0125*gravity_of_tank_oil)=
+    #        10**(1770.79/density - 1.64375)=
+    #         e**(4072.69738323/density - 3.78487)
+    # For temperature in Celsius:
+    #    10**(0.00091 * Farenheit) =
+    #    10**(0.001638*Celsius + 0.02912) =
+    #     e**(0.00377163*Celsius + 0.0670513)
+    #
+    # Removing constants factors we get
+    # (gor_ratio /
+    #  gas_gravity)) ** 0.83 / ( np.exp(4072.69738323 / density -
+    #  0.00377163438 * temperature_c)
+    #
+    # The equation occurs in this form as equation 21a in
+    # Batzle, Michael, and Zhijing Wang. "Seismic properties of pore fluids."
+    # Geophysics 57.11 (1992): 1396-1408.
+
+    ratio = gas_oil_ratio / gas_gravity
+    denominator = np.exp(4072 / density - 0.00377 * temperature)
+
+    return 24469793.9134 * ratio**0.83 / denominator

rock_physics_open/fluid_models/oil_model/oil_properties.py

@@ -0,0 +1,114 @@
+import warnings
+
+import numpy as np
+
+from .dead_oil_density import dead_oil_density
+from .dead_oil_velocity import dead_oil_velocity
+from .live_oil_density import live_oil_density
+from .live_oil_velocity import live_oil_velocity
+from .oil_bubble_point import bp_standing
+
+
+def oil_properties(
+    temp: np.ndarray | float,
+    pres: np.ndarray | float,
+    rho0: np.ndarray | float,
+    gor: np.ndarray | float,
+    gr: np.ndarray | float,
+) -> np.ndarray | float:
+    """
+    :param temp: Temperature (Celsius) of oil.
+    :param pres: Pressure (Pa) of oil
+    :param rho0: Density of the oil without dissolved gas at 15.6 degrees Celsius and
+                 atmospheric pressure. (kg/m^3)
+    :param gor: The volume ratio of gas to oil [l/l]
+    :param gr: Gas Gravity, molar mass of gas relative to air molar mas.
+    :return: vel_oil, den_oil, k_oil
+    """
+    # Since live_oil with gas_oil_ratio=0.0 is not equal to dead oil
+    # we use an apodization function to interpolate between the two
+
+    def triangular_window(x, length=2):
+        """
+        A triangular window function around the origin, 1.0 at x=0.0, linear
+        and 0.0 outside the window.
+        :param length: total length of the window, ie., function is nonzero in
+            [-length/2, length/2].
+        :param x: numpy array containing x'es to evaluate the window at
+        :return: value of window function at x.
+        """
+        x = np.asarray(x)  # Ensure x is a numpy array
+        window = np.clip((np.abs(x) - length / 2) / (length / 2), 0, 1)
+        return 1 - window
+
+    loil_den, loil_vel = live_oil(temp, pres, rho0, gor, gr)
+    doil_den, doil_vel = dead_oil(temp, pres, rho0)
+    window = triangular_window(gor)
+    den_oil = doil_den * window + (1 - window) * loil_den
+    vel_oil = doil_vel * window + (1 - window) * loil_vel
+    k_oil = vel_oil**2 * den_oil
+    return vel_oil, den_oil, k_oil
+
+
+def dead_oil(
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+) -> tuple[np.ndarray | float, np.ndarray | float]:
+    """
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. kg/m3
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :param pressure: Pressure (Pa) of oil
+    :param temperature: Temperature (Celsius) of oil.
+    :return: dead_oil_density, dead_oil_velocity
+    """
+    dead_oil_den = 1000 * dead_oil_density(
+        temperature, pressure * 1e-6, reference_density / 1000
+    )
+    dead_oil_vel = dead_oil_velocity(
+        temperature, pressure * 1e-6, reference_density / 1000
+    )
+    return dead_oil_den, dead_oil_vel
+
+
+def live_oil(
+    temperature: np.ndarray | float,
+    pressure: np.ndarray | float,
+    reference_density: np.ndarray | float,
+    gas_oil_ratio: np.ndarray | float,
+    gas_gravity: np.ndarray | float,
+) -> tuple[np.ndarray | float, np.ndarray | float]:
+    """
+    :param reference_density: Density of the oil without dissolved gas
+        at 15.6 degrees Celsius and atmospheric pressure. (kg/m^3)
+    :param gas_oil_ratio: The volume ratio of gas to oil [l/l]
+    :param gas_gravity: molar mass of gas relative to air molar mas.
+    :param pressure: Pressure (Pa) of oil
+    :param temperature: Temperature (Celsius) of oil.
+    :return: live_oil_density, live_oil_velocity
+    """
+    if np.any(
+        pressure
+        < bp_standing(reference_density, gas_oil_ratio, gas_gravity, temperature)
+    ):
+        warnings.warn(
+            "Pressure is below bubble point of oil, estimated elastic properties can be inaccurate",
+            stacklevel=1,
+        )
+    live_oil_den = 1000 * live_oil_density(
+        temperature,
+        pressure * 1e-6,
+        reference_density / 1000,
+        gas_oil_ratio,
+        gas_gravity,
+    )
+    live_oil_vel = live_oil_velocity(
+        temperature,
+        pressure * 1e-6,
+        reference_density / 1000,
+        gas_oil_ratio,
+        gas_gravity,
+    )
+    return live_oil_den, live_oil_vel

rock_physics_open/sandstone_models/__init__.py

@@ -0,0 +1,57 @@
+from .cemented_shalysand_sandyshale_models import cemented_shaly_sand_sandy_shale_model
+from .constant_cement_models import (
+    constant_cement_model,
+    constant_cement_model_dry,
+)
+from .constant_cement_optimisation import constant_cement_model_optimisation
+from .contact_cement_model import contact_cement_model
+from .curvefit_sandstone_models import (
+    curvefit_constant_cement,
+    curvefit_friable,
+    curvefit_patchy_cement,
+)
+from .friable_models import (
+    friable_model,
+    friable_model_dry,
+)
+from .friable_optimisation import friable_model_optimisation
+from .friable_shalysand_sandyshale_models import friable_shaly_sand_sandy_shale_model
+from .patchy_cement_fluid_substitution_model import (
+    patchy_cement_pressure_fluid_substitution,
+)
+from .patchy_cement_model import (
+    constant_cement_model_pcm,
+    patchy_cement_model_cem_frac,
+    patchy_cement_model_weight,
+)
+from .patchy_cement_optimisation import (
+    patchy_cement_model_optimisation,
+    patchy_cement_model_optimisation_multiwell,
+)
+from .unresolved_cemented_sandshale_models import (
+    unresolved_constant_cement_sand_shale_model,
+)
+from .unresolved_friable_sandshale_models import unresolved_friable_sand_shale_model
+
+__all__ = [
+    "cemented_shaly_sand_sandy_shale_model",
+    "constant_cement_model",
+    "constant_cement_model_dry",
+    "constant_cement_model_optimisation",
+    "contact_cement_model",
+    "curvefit_constant_cement",
+    "curvefit_friable",
+    "curvefit_patchy_cement",
+    "friable_model",
+    "friable_model_dry",
+    "friable_model_optimisation",
+    "friable_shaly_sand_sandy_shale_model",
+    "patchy_cement_pressure_fluid_substitution",
+    "constant_cement_model_pcm",
+    "patchy_cement_model_cem_frac",
+    "patchy_cement_model_weight",
+    "patchy_cement_model_optimisation",
+    "patchy_cement_model_optimisation_multiwell",
+    "unresolved_constant_cement_sand_shale_model",
+    "unresolved_friable_sand_shale_model",
+]