Minerals

digirock.Mineral

Base Class for defining Minerals. They are rock frame constituents.

Attributes:

Name	Type	Description
name	str	name of the mineral
density	float	density of the mineral in g/cc
bulk_modulus	float	Bulk modulus (compression) of the mineral in GPa
shear_modulus	float	Shear modulus of the mineral in GPa

bulk_modulus(self, props, **kwargs)

Return the bulk modulus.

Parameters:

Name	Type	Description	Default
props	Any	ignored	required
kwargs		ignored	{}

Returns:

Type	Description
float	constant value for Mineral bulk modulus

density(self, props, **kwargs)

Return the density.

Parameters:

Name	Type	Description	Default
props	Any	ignored	required
kwargs		ignored	{}

Returns:

Type	Description
float	constant value for Mineral density

elastic(self, props, **kwargs)

Pure elastic properties of mineral.

Uses acoustic_vel.

Returns:

Type	Description
Tuple[Union[numpy.ndarray, float], Union[numpy.ndarray, float], Union[numpy.ndarray, float]]	compressional velocity (m/s), shear velocity (m/s), density (g/cc)

get_summary(self)

Returns a summary of this class.

shear_modulus(self, props, **kwargs)

Return the shear modulus.

Parameters:

Name	Type	Description	Default
props	Any	ignored	required
kwargs		ignored	{}

Returns:

Type	Description
float	constant value for Mineral shear modulus

vp(self, props, **kwargs)

Compressional Velocity (m/s)

vs(self, props, **kwargs)

Shear Velocity (m/s)