Detailed Description

Orthotropic, saturation dependent swelling model. This property must be a solid phase property, it computes the stress increment depending on the saturation. A local coordinate system can be given for orthotropy.

Definition at line 34 of file SaturationDependentSwelling.h.

#include <SaturationDependentSwelling.h>

Inheritance diagram for MaterialPropertyLib::SaturationDependentSwelling:

[legend]

Collaboration diagram for MaterialPropertyLib::SaturationDependentSwelling:

[legend]

Public Member Functions
	SaturationDependentSwelling (std::string name, std::array< double, 3 > swelling_pressures, std::array< double, 3 > exponents, double const lower_saturation_limit, double const upper_saturation_limit, ParameterLib::CoordinateSystem const *const local_coordinate_system)

void	checkScale () const override

PropertyDataType	value (VariableArray const &variable_array, VariableArray const &variable_array_prev, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const override

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 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, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const

virtual PropertyDataType	dValue (VariableArray const &variable_array, 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. More...

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
std::array< double, 3 > const	p_
	Maximum swelling pressures, one for each spatial dimension. More...

std::array< double, 3 > const	lambda_
	Exponents, one for each spatial dimension. More...

double const	S_min_

double const	S_max_

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. More...

PropertyDataType	dvalue_

std::variant< Medium , Phase , Component * >	scale_

Constructor & Destructor Documentation

◆ SaturationDependentSwelling()

MaterialPropertyLib::SaturationDependentSwelling::SaturationDependentSwelling	(	std::string	name,
		std::array< double, 3 >	swelling_pressures,
		std::array< double, 3 >	exponents,
		double const	lower_saturation_limit,
		double const	upper_saturation_limit,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system
	)

Definition at line 20 of file SaturationDependentSwelling.cpp.

     : p_(std::move(swelling_pressures)),
       lambda_(std::move(exponents)),
       S_min_(lower_saturation_limit),
       S_max_(upper_saturation_limit),
       local_coordinate_system_(local_coordinate_system)
 {
     name_ = std::move(name);
 }

References MaterialPropertyLib::name, and MaterialPropertyLib::Property::name_.

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::SaturationDependentSwelling::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 38 of file SaturationDependentSwelling.cpp.

 {
     if (!std::holds_alternative<Phase*>(scale_))
     {
         OGS_FATAL(
             "The property 'SaturationDependentSwelling' is implemented on the "
             "'phase' scales only.");
     }
     auto const phase = std::get<Phase*>(scale_);
     if (phase->name != "Solid")
     {
         OGS_FATAL(
             "The property 'SaturationDependentSwelling' must be given in the "
             "'Solid' phase, not in '{:s}' phase.",
             phase->name);
     }
 }

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

◆ dValue()

PropertyDataType MaterialPropertyLib::SaturationDependentSwelling::dValue	(	VariableArray const &	variable_array,
		VariableArray const &	variable_array_prev,
		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 and the variables from the previous time step.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 101 of file SaturationDependentSwelling.cpp.

 {
     if (primary_variable != Variable::liquid_saturation)
     {
         OGS_FATAL(
             "SaturationDependentSwelling::dValue is implemented for "
             "derivatives with respect to liquid saturation only.");
     }
  
     auto const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
     auto const S_L_prev = std::get<double>(
         variable_array_prev[static_cast<int>(Variable::liquid_saturation)]);
  
     Eigen::Matrix<double, 3, 3> const e =
         local_coordinate_system_ == nullptr
             ? Eigen::Matrix<double, 3, 3>::Identity()
             : local_coordinate_system_->transformation_3d(pos);
  
     Eigen::Matrix<double, 3, 3> delta_sigma_sw =
         Eigen::Matrix<double, 3, 3>::Zero();
  
     if (S_L < S_min_)
     {
         return delta_sigma_sw;  // still being zero.
     }
  
     double const S_eff = std::clamp((S_L - S_min_) / (S_max_ - S_min_), 0., 1.);
     double const S_eff_prev =
         std::clamp((S_L_prev - S_min_) / (S_max_ - S_min_), 0., 1.);
  
     double const delta_S_eff = S_eff - S_eff_prev;
  
     // Heaviside(delta S_eff,sw)
     if (std::abs(delta_S_eff) <= 0)
     {
         return delta_sigma_sw;  // still being zero.
     }
  
     for (int i = 0; i < 3; ++i)
     {
         Eigen::Matrix<double, 3, 3> const ei_otimes_ei =
             e.col(i) * e.col(i).transpose();
  
         delta_sigma_sw +=
             lambda_[i] * p_[i] * std::pow(S_eff, lambda_[i] - 1) * ei_otimes_ei;
     }
     return (delta_sigma_sw / (S_max_ - S_min_)).eval();
 }

References lambda_, MaterialPropertyLib::liquid_saturation, local_coordinate_system_, OGS_FATAL, p_, S_max_, S_min_, and ParameterLib::CoordinateSystem::transformation_3d().

◆ value()

PropertyDataType MaterialPropertyLib::SaturationDependentSwelling::value	(	VariableArray const &	variable_array,
		VariableArray const &	variable_array_prev,
		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 and the variables from the previous time step.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 56 of file SaturationDependentSwelling.cpp.

 {
     auto const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
     auto const S_L_prev = std::get<double>(
         variable_array_prev[static_cast<int>(Variable::liquid_saturation)]);
  
     Eigen::Matrix<double, 3, 3> const e =
         local_coordinate_system_ == nullptr
             ? Eigen::Matrix<double, 3, 3>::Identity()
             : local_coordinate_system_->transformation_3d(pos);
  
     Eigen::Matrix<double, 3, 3> delta_sigma_sw =
         Eigen::Matrix<double, 3, 3>::Zero();
  
     if (S_L < S_min_)
     {
         return delta_sigma_sw;  // still being zero.
     }
  
     double const S_eff = std::clamp((S_L - S_min_) / (S_max_ - S_min_), 0., 1.);
     double const S_eff_prev =
         std::clamp((S_L_prev - S_min_) / (S_max_ - S_min_), 0., 1.);
  
     double const delta_S_eff = S_eff - S_eff_prev;
  
     // \Delta\sigma_{sw} = - \sum_i k_i (\lambda p S_{eff}^{(\lambda_i - 1)}
     // e_i \otimes e_i \Delta S_L / (S_{max} - S_{min}), where
     // e_i \otimes e_i is a square matrix with e_i,0^2 e_i,0*e_i,1 etc.
     for (int i = 0; i < 3; ++i)
     {
         Eigen::Matrix<double, 3, 3> const ei_otimes_ei =
             e.col(i) * e.col(i).transpose();
  
         delta_sigma_sw -=
             lambda_[i] * p_[i] * std::pow(S_eff, lambda_[i] - 1) * ei_otimes_ei;
     }
  
     return (delta_sigma_sw * delta_S_eff / dt).eval();
 }