Detailed Description

template<int GlobalDimension>
class MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >

A saturation dependent thermal conductivity model for soil.

This model is proposed by Somerton, W.~H. et al. [28], which takes the form of

\[ \lambda = \lambda_{\text{dry}} + \sqrt{S}(\lambda_{\text{wet}}-\lambda_{\text{dry}}), \]

where \(\lambda_{\text{dry}}\) is the thermal conductivity of soil at the dry state, \(\lambda_{\text{wet}}\) is the thermal conductivity of soil at the fully water saturated state, and \(S\) is the water saturation.

Definition at line 41 of file SoilThermalConductivitySomerton.h.

#include <SoilThermalConductivitySomerton.h>

Inheritance diagram for MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >:

[legend]

Collaboration diagram for MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >:

[legend]

Public Member Functions
	SoilThermalConductivitySomerton (std::string name, ParameterLib::Parameter< double > const &dry_thermal_conductivity, ParameterLib::Parameter< double > const &wet_thermal_conductivity, 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

	SoilThermalConductivitySomerton (std::string name, ParameterLib::Parameter< double > const &dry_thermal_conductivity, ParameterLib::Parameter< double > const &wet_thermal_conductivity, ParameterLib::CoordinateSystem const *const local_coordinate_system)

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

PropertyDataType	dValue (VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &pos, double const t, double const) const

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. 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
ParameterLib::Parameter< double > const &	dry_thermal_conductivity_
	Thermal conductivity of soil at the dry state. More...

ParameterLib::Parameter< double > const &	wet_thermal_conductivity_
	Thermal conductivity of soil at the fully water saturated state. More...

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

◆ SoilThermalConductivitySomerton() [1/2]

template<int GlobalDimension>

MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::SoilThermalConductivitySomerton	(	std::string	name,
		ParameterLib::Parameter< double > const &	dry_thermal_conductivity,
		ParameterLib::Parameter< double > const &	wet_thermal_conductivity,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system
	)

Definition at line 118 of file SoilThermalConductivitySomerton.cpp.

     : dry_thermal_conductivity_(dry_thermal_conductivity),
       wet_thermal_conductivity_(wet_thermal_conductivity),
       local_coordinate_system_(local_coordinate_system)
 {
     name_ = std::move(name);
  
     ParameterLib::SpatialPosition const pos;
     double const t = std::numeric_limits<double>::quiet_NaN();
  
     auto const lambda_try = dry_thermal_conductivity_(t, pos);
     auto const lambda_wet = wet_thermal_conductivity_(t, pos);
  
     if (lambda_try.size() != lambda_wet.size())
     {
         OGS_FATAL(
             "In 'SoilThermalConductivitySomerton' input data, the data size of "
             "dry_thermal_conductivity of '{:d}' is different from that of "
             "dry_thermal_conductivity of '{:d}'.",
             lambda_try.size(), lambda_wet.size());
     }
  
     for (std::size_t i = 0; i < lambda_try.size(); i++)
     {
         if (lambda_try[i] > lambda_wet[i])
         {
             OGS_FATAL(
                 "In 'SoilThermalConductivitySomerton', "
                 "dry_thermal_conductivity of '{:g}' is larger than "
                 "wet_thermal_conductivity of '{:g}'.",
                 lambda_try[i], lambda_wet[i]);
         }
     }
 }

References MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::dry_thermal_conductivity_, MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, OGS_FATAL, and MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::wet_thermal_conductivity_.

◆ SoilThermalConductivitySomerton() [2/2]

MaterialPropertyLib::SoilThermalConductivitySomerton< 1 >::SoilThermalConductivitySomerton	(	std::string	name,
		ParameterLib::Parameter< double > const &	dry_thermal_conductivity,
		ParameterLib::Parameter< double > const &	wet_thermal_conductivity,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system
	)

Definition at line 36 of file SoilThermalConductivitySomerton.cpp.

     : dry_thermal_conductivity_(dry_thermal_conductivity),
       wet_thermal_conductivity_(wet_thermal_conductivity),
       local_coordinate_system_(local_coordinate_system)
 {
     name_ = std::move(name);
  
     ParameterLib::SpatialPosition const pos;
     double const t = std::numeric_limits<double>::quiet_NaN();
  
     double const lambda_try = dry_thermal_conductivity_(t, pos)[0];
     double const lambda_wet = wet_thermal_conductivity_(t, pos)[0];
  
     if (lambda_try > lambda_wet)
     {
         OGS_FATAL(
             "In 'SoilThermalConductivitySomerton', "
             "dry_thermal_conductivity of '{:g}' is larger than "
             "wet_thermal_conductivity of '{:g}'.",
             lambda_try, lambda_wet);
     }
 }

References MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::dry_thermal_conductivity_, MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, OGS_FATAL, and MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::wet_thermal_conductivity_.

Member Function Documentation

◆ checkScale()

template<int GlobalDimension>

void MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 50 of file SoilThermalConductivitySomerton.h.

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

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

◆ dValue() [1/2]

template<int GlobalDimension>

PropertyDataType MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::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 209 of file SoilThermalConductivitySomerton.cpp.

 {
     if (variable != Variable::liquid_saturation)
     {
         OGS_FATAL(
             "SoilThermalConductivitySomerton::dValue is implemented for "
             "derivatives with respect to liquid saturation only.");
     }
  
     double const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
  
     if (S_L <= 0.0 || S_L > 1.0)
     {
         Eigen::Matrix<double, GlobalDimension, GlobalDimension> zero =
             Eigen::Matrix<double, GlobalDimension, GlobalDimension>::Zero();
         return zero;
     }
  
     auto const lambda_dry_data = dry_thermal_conductivity_(t, pos);
     auto const lambda_wet_data = wet_thermal_conductivity_(t, pos);
  
     std::vector<double> derivative_data;
     derivative_data.reserve(lambda_dry_data.size());
     for (std::size_t i = 0; i < lambda_dry_data.size(); i++)
     {
         derivative_data.emplace_back(
             0.5 * (lambda_wet_data[i] - lambda_dry_data[i]) / std::sqrt(S_L));
     }
  
     // Local coordinate transformation is only applied for the case that the
     // initial intrinsic permeability is given with orthotropic assumption.
     if (local_coordinate_system_ && (derivative_data.size() == GlobalDimension))
     {
         Eigen::Matrix<double, GlobalDimension, GlobalDimension> const e =
             local_coordinate_system_->transformation<GlobalDimension>(pos);
         Eigen::Matrix<double, GlobalDimension, GlobalDimension> k =
             Eigen::Matrix<double, GlobalDimension, GlobalDimension>::Zero();
  
         for (int i = 0; i < GlobalDimension; ++i)
         {
             Eigen::Matrix<double, GlobalDimension, GlobalDimension> const
                 ei_otimes_ei = e.col(i) * e.col(i).transpose();
  
             k += derivative_data[i] * ei_otimes_ei;
         }
         return k;
     }
  
     return fromVector(derivative_data);
 }

References MaterialPropertyLib::fromVector(), MaterialPropertyLib::liquid_saturation, and OGS_FATAL.

◆ dValue() [2/2]

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

virtual

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 88 of file SoilThermalConductivitySomerton.cpp.

 {
     if (variable != Variable::liquid_saturation)
     {
         OGS_FATAL(
             "SoilThermalConductivitySomerton::dValue is implemented for "
             "derivatives with respect to liquid saturation only.");
     }
  
     double const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
  
     if (S_L <= 0.0 || S_L > 1.0)
     {
         return 0.0;
     }
  
     double const lambda_dry = dry_thermal_conductivity_(t, pos)[0];
     double const lambda_wet = wet_thermal_conductivity_(t, pos)[0];
  
     return 0.5 * (lambda_wet - lambda_dry) / std::sqrt(S_L);
 }

References MaterialPropertyLib::liquid_saturation, and OGS_FATAL.

◆ value() [1/2]

template<int GlobalDimension>

PropertyDataType MaterialPropertyLib::SoilThermalConductivitySomerton< GlobalDimension >::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 159 of file SoilThermalConductivitySomerton.cpp.

 {
     double const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
  
     // (S_L <= 0.0)
     std::vector<double> lambda_data = dry_thermal_conductivity_(t, pos);
  
     if (S_L > 1.0)
     {
         lambda_data = wet_thermal_conductivity_(t, pos);
     }
  
     if (S_L > 0.0 && S_L <= 1.0)
     {
         auto const lambda_wet_data = wet_thermal_conductivity_(t, pos);
  
         for (std::size_t i = 0; i < lambda_data.size(); i++)
         {
             lambda_data[i] +=
                 std::sqrt(S_L) * (lambda_wet_data[i] - lambda_data[i]);
         }
     }
  
     // Local coordinate transformation is only applied for the case that the
     // initial intrinsic permeability is given with orthotropic assumption.
     if (local_coordinate_system_ && (lambda_data.size() == GlobalDimension))
     {
         Eigen::Matrix<double, GlobalDimension, GlobalDimension> const e =
             local_coordinate_system_->transformation<GlobalDimension>(pos);
         Eigen::Matrix<double, GlobalDimension, GlobalDimension> k =
             Eigen::Matrix<double, GlobalDimension, GlobalDimension>::Zero();
  
         for (int i = 0; i < GlobalDimension; ++i)
         {
             Eigen::Matrix<double, GlobalDimension, GlobalDimension> const
                 ei_otimes_ei = e.col(i) * e.col(i).transpose();
  
             k += lambda_data[i] * ei_otimes_ei;
         }
         return k;
     }
  
     return fromVector(lambda_data);
 }

References MaterialPropertyLib::fromVector(), and MaterialPropertyLib::liquid_saturation.

◆ value() [2/2]

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

virtual

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 63 of file SoilThermalConductivitySomerton.cpp.

 {
     double const S_L = std::get<double>(
         variable_array[static_cast<int>(Variable::liquid_saturation)]);
  
     if (S_L <= 0.0)
     {
         return dry_thermal_conductivity_(t, pos)[0];
     }
  
     if (S_L > 1.0)
     {
         return wet_thermal_conductivity_(t, pos)[0];
     }
  
     double const lambda_dry = dry_thermal_conductivity_(t, pos)[0];
  
     return lambda_dry +
            std::sqrt(S_L) * (wet_thermal_conductivity_(t, pos)[0] - lambda_dry);
 }