MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim > Class Template Reference

Detailed Description

template<int GlobalDim>
class MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >

Porosity mixing based model for effective heat conduction

This property is a medium property. The corresponding values are taken from the liquid/solid phase.

Definition at line 27 of file EffectiveThermalConductivityPorosityMixing.h.

#include <EffectiveThermalConductivityPorosityMixing.h>

Inheritance diagram for MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >:

Collaboration diagram for MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >:

Public Member Functions
	EffectiveThermalConductivityPorosityMixing (std::string name, 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
	EffectiveThermalConductivityPorosityMixing (std::string name, ParameterLib::CoordinateSystem const *const local_coordinate_system)
void	checkScale () const
PropertyDataType	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) const
PropertyDataType	dValue (VariableArray const &, Variable const, ParameterLib::SpatialPosition const &, double const, 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.
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::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

EffectiveThermalConductivityPorosityMixing() [1/2]

template<int GlobalDim>

MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::EffectiveThermalConductivityPorosityMixing	(	std::string	name,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Definition at line 108 of file EffectiveThermalConductivityPorosityMixing.cpp.

    : local_coordinate_system_(local_coordinate_system)
{
    name_ = std::move(name);
}

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

EffectiveThermalConductivityPorosityMixing() [2/2]

MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< 1 >::EffectiveThermalConductivityPorosityMixing	(	std::string	name,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system )

Definition at line 23 of file EffectiveThermalConductivityPorosityMixing.cpp.

    : local_coordinate_system_(local_coordinate_system)
{
    name_ = std::move(name);
}

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

Member Function Documentation

checkScale() [1/2]

void MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< 1 >::checkScale ( ) const

virtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 33 of file EffectiveThermalConductivityPorosityMixing.cpp.

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

References OGS_FATAL.

checkScale() [2/2]

template<int GlobalDim>

void MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 118 of file EffectiveThermalConductivityPorosityMixing.cpp.

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

References OGS_FATAL.

dValue() [1/2]

PropertyDataType MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< 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 96 of file EffectiveThermalConductivityPorosityMixing.cpp.

{
    OGS_FATAL(
        "dValue is not implemented for "
        "EffectiveThermalConductivityPorosityMixing");
}

References OGS_FATAL.

dValue() [2/2]

template<int GlobalDim>

PropertyDataType MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::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 193 of file EffectiveThermalConductivityPorosityMixing.cpp.

{
    OGS_FATAL(
        "dValue is not implemented for "
        "EffectiveThermalConductivityPorosityMixing");
}

References OGS_FATAL.

value() [1/2]

PropertyDataType MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< 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 44 of file EffectiveThermalConductivityPorosityMixing.cpp.

{
    auto const& medium = std::get<Medium*>(scale_);
 
    // Assuming there is either a gas phase or a liquid phase or both.
    auto const gas_phase =
        medium->hasPhase("Gas") ? &medium->phase("Gas") : nullptr;
    auto const liquid_phase = medium->hasPhase("AqueousLiquid")
                                  ? &medium->phase("AqueousLiquid")
                                  : nullptr;
    // Assuming there is always a solid phase.
    auto const& solid_phase = medium->phase("Solid");
 
    auto const gas_thermal_conductivity =
        gas_phase
            ? gas_phase
                  ->property(
                      MaterialPropertyLib::PropertyType::thermal_conductivity)
                  .template value<double>(variable_array, pos, t, dt)
            : 0.;
 
    auto const liquid_thermal_conductivity =
        liquid_phase
            ? liquid_phase
                  ->property(
                      MaterialPropertyLib::PropertyType::thermal_conductivity)
                  .template value<double>(variable_array, pos, t, dt)
            : 0.;
 
    auto const solid_thermal_conductivity =
        solid_phase
            .property(MaterialPropertyLib::PropertyType::thermal_conductivity)
            .template value<double>(variable_array, pos, t, dt);
 
    auto const porosity = variable_array.porosity;
    auto const S_L = variable_array.liquid_saturation;
    auto const S_G = 1. - S_L;
 
    auto const phi_G = porosity * S_G;
    auto const phi_L = porosity * S_L;
    auto const phi_S = 1. - porosity;
 
    double const effective_thermal_conductivity =
        phi_G * gas_thermal_conductivity + phi_L * liquid_thermal_conductivity +
        phi_S * solid_thermal_conductivity;
 
    return effective_thermal_conductivity;
}

References MaterialPropertyLib::VariableArray::liquid_saturation, MaterialPropertyLib::porosity, MaterialPropertyLib::VariableArray::porosity, and MaterialPropertyLib::thermal_conductivity.

value() [2/2]

template<int GlobalDim>

PropertyDataType MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::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 129 of file EffectiveThermalConductivityPorosityMixing.cpp.

{
    auto const& medium = std::get<Medium*>(scale_);
    // Assuming there is either a gas phase or a liquid phase or both.
    auto const gas_phase =
        medium->hasPhase("Gas") ? &medium->phase("Gas") : nullptr;
    auto const liquid_phase = medium->hasPhase("AqueousLiquid")
                                  ? &medium->phase("AqueousLiquid")
                                  : nullptr;
    // Assuming there is always a solid phase.
    auto const& solid_phase = medium->phase("Solid");
 
    auto const gas_thermal_conductivity =
        gas_phase
            ? gas_phase
                  ->property(
                      MaterialPropertyLib::PropertyType::thermal_conductivity)
                  .template value<double>(variable_array, pos, t, dt)
            : 0.;
 
    auto const liquid_thermal_conductivity =
        liquid_phase
            ? liquid_phase
                  ->property(
                      MaterialPropertyLib::PropertyType::thermal_conductivity)
                  .template value<double>(variable_array, pos, t, dt)
            : 0.;
 
    auto solid_thermal_conductivity = formEigenTensor<GlobalDim>(
        solid_phase
            .property(MaterialPropertyLib::PropertyType::thermal_conductivity)
            .value(variable_array, pos, t, dt));
 
    auto const porosity = variable_array.porosity;
 
    auto const S_L = variable_array.liquid_saturation;
    auto const S_G = 1. - S_L;
 
    auto const phi_G = porosity * S_G;
    auto const phi_L = porosity * S_L;
    auto const phi_S = 1. - porosity;
 
    // Local coordinate transformation is only applied for the case that the
    // initial solid thermal conductivity is given with orthotropic assumption.
    if (local_coordinate_system_ &&
        (solid_thermal_conductivity.cols() == GlobalDim))
    {
        solid_thermal_conductivity =
            local_coordinate_system_->rotateTensor<GlobalDim>(
                solid_thermal_conductivity, pos);
    }
    auto const I = Eigen::Matrix<double, GlobalDim, GlobalDim>::Identity();
    Eigen::Matrix<double, GlobalDim, GlobalDim> const
        effective_thermal_conductivity = (phi_G * gas_thermal_conductivity +
                                          phi_L * liquid_thermal_conductivity) *
                                             I +
                                         phi_S * solid_thermal_conductivity;
    return effective_thermal_conductivity;
}

References MaterialPropertyLib::VariableArray::liquid_saturation, MaterialPropertyLib::porosity, MaterialPropertyLib::VariableArray::porosity, and MaterialPropertyLib::thermal_conductivity.

Member Data Documentation

local_coordinate_system_

template<int GlobalDim>

ParameterLib::CoordinateSystem const* const MaterialPropertyLib::EffectiveThermalConductivityPorosityMixing< GlobalDim >::local_coordinate_system_

private

Definition at line 47 of file EffectiveThermalConductivityPorosityMixing.h.

---

The documentation for this class was generated from the following files:

• MaterialLib/MPL/Properties/EffectiveThermalConductivityPorosityMixing.h
• MaterialLib/MPL/Properties/EffectiveThermalConductivityPorosityMixing.cpp