Skip to content

Commit

Permalink
Improve parameter names, update docstring, format according to black
Browse files Browse the repository at this point in the history
  • Loading branch information
hflesche authored and eivindjahren committed Aug 26, 2022
1 parent 40a72f8 commit 7401132
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/open_petro_elastic/material/sandstone/patchy_cement.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,26 @@ def patchy_cement(
lower_bound_pressure,
critical_porosity=0.4,
shear_reduction=1.0,
coordination_number=9,
cement_coordination_number = 9,
friable_coordination_number=9,
cement_coordination_number=9,
):
"""
A hybrid sandstone model based on the patchy cement model of Avseth et. al (2016).
:param sand: Material representing the sand of the sandstone.
:param cement: Material representing the cement of the sandstone.
:param porosity: Porosity of the uncemented sandstone.
:param porosity: Porosity of the friable sandstone.
:param contact_cement_porosity: Porosity of the contact cement in the
hybrid model.
:param constant_cement_porosity: The porosity of constant cement
:param upper_bound_porosity: The porosity of constant cement
in the hybrid model.
:param pressure: Pressure used for friable sand.
:param lower_bound_pressure: The pressure used for the lower bound
friable sand.
:param critical_porosity: The critical porosity of the sandstone.
:param shear_reduction: Shear reduction factor.
:param coordination number: The coordination number of the sand.
:param friable_coordination_number: The number of grain-grain contacts in the friable model
:param cement_coordination_number: The number of grain-grain contacts in the cemented model - to be kept constant
Avseth, Per & Skjei, Norunn & Mavko, Gary. (2016). Rock-physics modeling of
stress sensitivity and 4D time shifts in patchy cemented sandstones —
Expand All @@ -55,15 +56,15 @@ def patchy_cement(
porosity,
critical_porosity,
pressure,
coordination_number,
friable_coordination_number,
shear_reduction,
)
lower_bound = friable_sand(
dense_packing,
porosity,
critical_porosity,
lower_bound_pressure,
coordination_number,
friable_coordination_number,
shear_reduction,
)
upper_bound = constant_cement(
Expand Down

0 comments on commit 7401132

Please sign in to comment.