Detailed Description

template<MeanType MeantType, int GlobalDimension>
class MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >

Saturation dependent thermal conductivity model for soil.

The arithmetic_squareroot model is proposed by Somerton, W.~H. et al. [38], which takes the form of

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

. The arithmetic_linear model is linear in the saturation and has the form

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

The geometric model uses the weighted geometric mean

\[ \lambda = \lambda_{\text{dry}}^{1-S} * \lambda_{\text{wet}}^S, \]

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 46 of file SaturationWeightedThermalConductivity.h.

#include <SaturationWeightedThermalConductivity.h>

Inheritance diagram for MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >:

[legend]

Collaboration diagram for MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >:

[legend]

Public Member Functions
	SaturationWeightedThermalConductivity (std::string name, ParameterLib::Parameter< double > const &dry_thermal_conductivity, ParameterLib::Parameter< double > const &wet_thermal_conductivity)
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 &	dry_thermal_conductivity_
	Thermal conductivity of soil at the dry state.
ParameterLib::Parameter< double > const &	wet_thermal_conductivity_
	Thermal conductivity of soil at the fully water saturated state.

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

◆ SaturationWeightedThermalConductivity()

template<MeanType MeanType, int GlobalDimension>

MaterialPropertyLib::SaturationWeightedThermalConductivity< MeanType, GlobalDimension >::SaturationWeightedThermalConductivity	(	std::string	name,
		ParameterLib::Parameter< double > const &	dry_thermal_conductivity,
		ParameterLib::Parameter< double > const &	wet_thermal_conductivity )

Definition at line 76 of file SaturationWeightedThermalConductivity.cpp.

    : dry_thermal_conductivity_(dry_thermal_conductivity),
      wet_thermal_conductivity_(wet_thermal_conductivity)
{
    name_ = std::move(name);
 
    ParameterLib::SpatialPosition const pos;
    double const t = std::numeric_limits<double>::quiet_NaN();
 
    auto const lambda_dry = dry_thermal_conductivity_(t, pos);
    auto const lambda_wet = wet_thermal_conductivity_(t, pos);
 
    if (lambda_dry.size() != lambda_wet.size())
    {
        OGS_FATAL(
            "In 'SaturationWeightedThermalConductivity' input data, the data "
            "size of "
            "dry_thermal_conductivity of '{:d}' is different from that of "
            "dry_thermal_conductivity of '{:d}'.",
            lambda_dry.size(), lambda_wet.size());
    }
 
    for (std::size_t i = 0; i < lambda_dry.size(); i++)
    {
        if (lambda_dry[i] > lambda_wet[i])
        {
            OGS_FATAL(
                "In 'SaturationWeightedThermalConductivity', "
                "dry_thermal_conductivity of '{:g}' is larger than "
                "wet_thermal_conductivity of '{:g}'.",
                lambda_dry[i], lambda_wet[i]);
        }
    }
    if constexpr (MeanType == MeanType::GEOMETRIC)
    {
        if (lambda_dry.size() != 1 && lambda_dry.size() != GlobalDimension)
        {
            OGS_FATAL(
                "The saturation weighted geometric mean"
                "is not implemented for arbitrary anisotropic thermal "
                "conductivities and requires to be in diagonal shape.");
        }
    }
}

References dry_thermal_conductivity_, MaterialPropertyLib::GEOMETRIC, MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, OGS_FATAL, and wet_thermal_conductivity_.

Member Function Documentation

◆ checkScale()

template<MeanType MeantType, int GlobalDimension>

void MaterialPropertyLib::SaturationWeightedThermalConductivity< MeantType, GlobalDimension >::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 54 of file SaturationWeightedThermalConductivity.h.

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

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

◆ dValue()

template<MeanType MeanType, int GlobalDimension>

PropertyDataType MaterialPropertyLib::SaturationWeightedThermalConductivity< MeanType, 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 156 of file SaturationWeightedThermalConductivity.cpp.

{
    if (variable != Variable::liquid_saturation)
    {
        OGS_FATAL(
            "SaturationWeightedThermalConductivity::dValue is implemented for "
            "derivatives with respect to liquid saturation only.");
    }
 
    double const S_L = variable_array.liquid_saturation;
 
    auto const lambda_dry_data = dry_thermal_conductivity_(t, pos);
 
    std::vector<double> derivative_data(lambda_dry_data.size(), 0.0);
    if (S_L <= 0.0 || S_L > 1.0)
    {
        return fromVector(derivative_data);
    }
    for (std::size_t i = 0; i < lambda_dry_data.size(); i++)
    {
        derivative_data[i] = computeDAverage<MeanType>(
            S_L, lambda_dry_data[i], wet_thermal_conductivity_(t, pos)[i]);
    }
    return fromVector(derivative_data);
}

References MaterialPropertyLib::computeDAverage(), dry_thermal_conductivity_, MaterialPropertyLib::fromVector(), MaterialPropertyLib::liquid_saturation, MaterialPropertyLib::VariableArray::liquid_saturation, OGS_FATAL, and wet_thermal_conductivity_.

◆ value()

template<MeanType MeanType, int GlobalDimension>

PropertyDataType MaterialPropertyLib::SaturationWeightedThermalConductivity< MeanType, 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 127 of file SaturationWeightedThermalConductivity.cpp.

{
    double const S_L = variable_array.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);
    }
 
    else if (S_L > 0.0 && S_L <= 1.0)
    {
        for (std::size_t i = 0; i < lambda_data.size(); i++)
        {
            lambda_data[i] = computeAverage<MeanType>(
                S_L, lambda_data[i], wet_thermal_conductivity_(t, pos)[i]);
        }
    }
 
    return fromVector(lambda_data);
}