Detailed Description

template<int DisplacementDim>
class MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >

A strain dependent intrinsic permeability model.

The model was proposed in [45] and it was further investigated in [46] .

The model takes the form of

\[ \mathbf{k} =f(\epsilon_v) e^{b_1 {\bar\epsilon}^p}\mathbf{k}_0 \]

with

\[ f(\epsilon_v)= \begin{cases} 10^{b_2 \epsilon_v}, & \epsilon_v <=0\\ 10^{b_3 \epsilon_v}, & \epsilon_v >0 \end{cases} \]

where

\( \epsilon_v \)	the volumetric strain,
\( {\bar\epsilon}^p\)	the equivalent plastic strain,
\(\mathbf{k}_0\)	the initial intrinsic permeability,
\(b_1,\,b_2,\,b_3\)	the three parameters.

Note: In [45] and [46] , from the point of view of experiment of permeability change, the symbols of \( \Delta \epsilon_v \) and \(\Delta {\bar\epsilon}^p\) are used for \(\epsilon_v \) and \({\bar\epsilon}^p\), respectively. That means that the symbols of \( \Delta \epsilon_v \) and \(\Delta {\bar\epsilon}^p\) refer to the increment of the volumetric strain and the increment of the equivalent plastic strain, respectively, from the beginning of the experiment.

Definition at line 63 of file StrainDependentPermeability.h.

#include <StrainDependentPermeability.h>

Inheritance diagram for MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >:

[legend]

Collaboration diagram for MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >:

[legend]

Public Member Functions
	StrainDependentPermeability (std::string name, ParameterLib::Parameter< double > const &k0, double const b1, double const b2, double const b3, double const minimum_permeability, double const maximum_permeability, ParameterLib::CoordinateSystem const *const local_coordinate_system)
void	checkScale () const override
PropertyDataType	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
PropertyDataType	dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override
Public Member Functions inherited from MaterialPropertyLib::Property
virtual	~Property ()
virtual PropertyDataType	initialValue (ParameterLib::SpatialPosition const &pos, double const t) const
virtual PropertyDataType	value () const
virtual PropertyDataType	value (VariableArray const &variable_array, VariableArray const &variable_array_prev, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
virtual PropertyDataType	dValue (VariableArray const &variable_array, VariableArray const &variable_array_prev, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
virtual PropertyDataType	d2Value (VariableArray const &variable_array, Variable const variable1, Variable const variable2, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
	Default implementation: 2nd derivative of any constant property is zero.
virtual void	setProperties (std::vector< std::unique_ptr< Phase > > const &phases)
	Default implementation:
void	setScale (std::variant< Medium , Phase , Component * > scale)
template<typename T>
T	initialValue (ParameterLib::SpatialPosition const &pos, double const t) const
template<typename T>
T	value () const
template<typename T>
T	value (VariableArray const &variable_array, VariableArray const &variable_array_prev, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
template<typename T>
T	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
template<typename T>
T	dValue (VariableArray const &variable_array, VariableArray const &variable_array_prev, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
template<typename T>
T	dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
template<typename T>
T	d2Value (VariableArray const &variable_array, Variable const &variable1, Variable const &variable2, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const

Private Attributes
ParameterLib::Parameter< double > const &	k0_
	Initial intrinsic permeability.
double const	b1_
double const	b2_
double const	b3_
double const	minimum_permeability_
double const	maximum_permeability_
ParameterLib::CoordinateSystem const *const	local_coordinate_system_

Additional Inherited Members
Protected Attributes inherited from MaterialPropertyLib::Property
std::string	name_
PropertyDataType	value_
	The single value of a property.
PropertyDataType	dvalue_
std::variant< Medium , Phase , Component * >	scale_

Constructor & Destructor Documentation

◆ StrainDependentPermeability()

template<int DisplacementDim>

MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >::StrainDependentPermeability	(	std::string	name,
		ParameterLib::Parameter< double > const &	k0,
		double const	b1,
		double const	b2,
		double const	b3,
		double const	minimum_permeability,
		double const	maximum_permeability,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Definition at line 26 of file StrainDependentPermeability.cpp.

    : k0_(k0),
      b1_(b1),
      b2_(b2),
      b3_(b3),
      minimum_permeability_(minimum_permeability),
      maximum_permeability_(maximum_permeability),
      local_coordinate_system_(local_coordinate_system)
{
    name_ = std::move(name);
}

References b1_, b2_, b3_, k0_, local_coordinate_system_, maximum_permeability_, minimum_permeability_, MaterialPropertyLib::name, and MaterialPropertyLib::Property::name_.

Member Function Documentation

◆ checkScale()

template<int DisplacementDim>

void MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 43 of file StrainDependentPermeability.cpp.

{
    if (!std::holds_alternative<Medium*>(scale_))
    {
        OGS_FATAL(
            "The property 'StrainDependentPermeability' is "
            "implemented on the 'medium' scale only.");
    }
}

References OGS_FATAL, and MaterialPropertyLib::Property::scale_.

◆ dValue()

template<int DisplacementDim>

PropertyDataType MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >::dValue	(	VariableArray const &	variable_array,
		Variable const	variable,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

overridevirtual

This virtual method will compute the property derivative value based on the variables that are passed as arguments with the default implementation using empty variables array for the previous time step.

The default implementation of this method only returns the property value derivative without altering it.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 97 of file StrainDependentPermeability.cpp.

{
    if (variable == Variable::mechanical_strain)
    {
        return 0.;
    }
 
    OGS_FATAL(
        "The derivative of the intrinsic permeability of "
        "StrainDependentPermeabilityis not implemented.");
}

References MaterialPropertyLib::mechanical_strain, and OGS_FATAL.

◆ value()

template<int DisplacementDim>

PropertyDataType MaterialPropertyLib::StrainDependentPermeability< DisplacementDim >::value	(	VariableArray const &	variable_array,
		ParameterLib::SpatialPosition const &	pos,
		double const	t,
		double const	dt ) const

overridevirtual

This virtual method will compute the property value based on the variables that are passed as arguments with the default implementation using empty variables array for the previous time step.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 54 of file StrainDependentPermeability.cpp.

{
    double const e_vol = variable_array.volumetric_strain;
    double const e_vol_pls = variable_array.equivalent_plastic_strain;
 
    auto k_data = k0_(t, pos);
 
    double const ten_base_exponent = e_vol > 0.0 ? b3_ * e_vol : b2_ * e_vol;
    double const factor =
        std::pow(10.0, ten_base_exponent) * std::exp(b1_ * e_vol_pls);
 
    for (auto& k_i : k_data)
    {
        k_i = std::clamp(k_i * factor, minimum_permeability_,
                         maximum_permeability_);
    }
 
    // Local coordinate transformation is only applied for the case that the
    // initial intrinsic permeability is given with orthotropic assumption.
    if (local_coordinate_system_ && (k_data.size() == DisplacementDim))
    {
        Eigen::Matrix<double, DisplacementDim, DisplacementDim> const e =
            local_coordinate_system_->transformation<DisplacementDim>(pos);
        Eigen::Matrix<double, DisplacementDim, DisplacementDim> k =
            Eigen::Matrix<double, DisplacementDim, DisplacementDim>::Zero();
 
        for (int i = 0; i < DisplacementDim; ++i)
        {
            Eigen::Matrix<double, DisplacementDim, DisplacementDim> const
                ei_otimes_ei = e.col(i) * e.col(i).transpose();
 
            k += k_data[i] * ei_otimes_ei;
        }
        return k;
    }
 
    return fromVector(k_data);
}