Porosity Adjustment Models

digirock.PoroAdjust

Base porosity adjustment class

Implements porosity adjustments for density, vp and vs. Classes which inherit this class should implement the modifications to the bulk and shear moduli.

bulk_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the bulk modulus.

density(self, props, **kwargs)

Returns density of RockFrame using volume fraction average, see [mixed_denisty][digirock.models._mod.mixed_density].

Parameters:

Name	Type	Description	Default
props	Dict[str, Union[numpy.ndarray, float, int]]	A dictionary of properties required.	required
kwargs		ignored	{}

Returns:

Type	Description
Union[numpy.ndarray, float]	density (g/cc)

shear_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the shear modulus.

vp(self, props, **kwargs)

Returns compression velocity of RockFrame

Parameters:

Name	Type	Description	Default
props	Dict[str, Union[numpy.ndarray, float, int]]	A dictionary of properties required.	required
kwargs		ignored	{}

Returns:

Type	Description
Union[numpy.ndarray, float]	velocity (m/s).

vs(self, props, **kwargs)

Returns shear velocity of RockFrame

Parameters:

Name	Type	Description	Default
props	Dict[str, Union[numpy.ndarray, float, int]]	A dictionary of properties required.	required
kwargs		ignored	{}

Returns:

Type	Description
Union[numpy.ndarray, float]	velocity (m/s).

digirock.NurCriticalPoroAdjust

Nur's Critical porosity adjustment.

__init__(self, transform_keys, element, critical_poro, name=None) special

Parameters:

Name	Type	Description	Default
critical_poro	float	Critical porosity inflection point in Por vs Vp (0 < crit_por < 1)	required

bulk_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the bulk modulus.

get_summary(self)

Returns a summary of this class.

shear_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the shear modulus.

digirock.FixedPoroAdjust

Fixed Porosity Adjustment

Modulii \(m\) are transformed by porosity \(\phi\)

\[ m_{\phi} = m * (1-2.8 *\phi) \]

bulk_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the bulk modulus.

shear_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the shear modulus.

digirock.LeeConsPoroAdjust

Lee/Pride 2005 Consolidation parameter porosity adjustment.

__init__(self, transform_keys, element, cons_alpha, gamma=None, name=None) special

If gamma is None:

\[ \gamma = \frac{1 + 2\alpha}{1 + \alpha} \]

bulk_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the bulk modulus.

\[ k_{dry} = k_0 * \frac{1 - \phi}{1 - \alpha\phi} \]

get_summary(self)

Returns a summary of this class.

shear_modulus(self, props, **kwargs)

Applies the class porosity adjustment to the shear modulus.

\[ \mu_{dry} = \mu_0\frac{1 - \phi}{1 - \alpha\gamma\phi} \]