Detailed Description

Effective medium property obtained by volume fraction averaging

This property must be a medium property. It computes the effective property based on the phase properties as a volume fraction weighted average in the following form

\[ X_{\mathrm{eff}} = \phi_\mathrm{p}\,X_\mathrm{pR} + \phi_\mathrm{f}\,X_\mathrm{fR} + \phi_\mathrm{l}\,X_\mathrm{lR} = (1-\phi) X_\mathrm{pR} + \phi_\mathrm{f}\,X_\mathrm{fR} + (\phi - \phi_\mathrm{f}) X_\mathrm{lR} \]

where \(\phi\) is the porosity (pore space volume fraction), \(\phi_\mathrm{p}\) is the porous solid skeleton volume fraction, \(\phi_\mathrm{f}=\phi\,S_\mathrm{fr}\) is the frozen volume fraction, obtained from the frozen liquid (ice) saturation \(S_\mathrm{fr}\) (the fraction of the pore space occupied by ice, given by the medium's frozen_liquid_saturation property), \(\phi_\mathrm{l}\) is the liquid one. \(\mathrm{R}\) stands for the real/pure phase property.

Definition at line 39 of file VolumeFractionAverage.h.

#include <VolumeFractionAverage.h>

Inheritance diagram for MaterialPropertyLib::VolumeFractionAverage:

[legend]

Collaboration diagram for MaterialPropertyLib::VolumeFractionAverage:

[legend]

Classes
struct	PhaseProperties

Public Member Functions
	VolumeFractionAverage (std::string name)
void	checkScale () const override
void	setProperties (std::vector< std::unique_ptr< Phase > > const &phases) override
	Default implementation:
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.
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

Protected Attributes
PropertyType	prop_type_
PhaseProperties	properties_
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

◆ VolumeFractionAverage()

MaterialPropertyLib::VolumeFractionAverage::VolumeFractionAverage ( std::string name )

explicit

Definition at line 11 of file VolumeFractionAverage.cpp.

{
    // get the corresponding property's name
    name_ = std::move(name);
 
    prop_type_ = convertStringToProperty(name_);
}

References MaterialPropertyLib::convertStringToProperty(), MaterialPropertyLib::name, MaterialPropertyLib::Property::name_, and prop_type_.

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::VolumeFractionAverage::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 19 of file VolumeFractionAverage.cpp.

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

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

◆ dValue()

PropertyDataType MaterialPropertyLib::VolumeFractionAverage::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 117 of file VolumeFractionAverage.cpp.

{
    if (variable != Variable::temperature)
    {
        OGS_FATAL(
            "VolumeFractionAverage::dValue is implemented for derivatives with "
            "respect to temperature only.");
    }
 
    auto const& medium = *std::get<Medium*>(scale_);
    auto const& porosity = medium[PropertyType::porosity];
    auto const phi =
        std::get<double>(porosity.value(variable_array, pos, t, dt));
 
    double dS_fr_dT = 0;
    double prop_value_frozen = 0;
 
    if (medium.hasProperty(PropertyType::frozen_liquid_saturation))
    {
        auto const& saturation = medium[PropertyType::frozen_liquid_saturation];
        dS_fr_dT = std::get<double>(saturation.dValue(
            variable_array, Variable::temperature, pos, t, dt));
        prop_value_frozen = std::get<double>(
            properties_.frozen->value(variable_array, pos, t, dt));
    }
 
    double prop_value_liquid =
        std::get<double>(properties_.liquid->value(variable_array, pos, t, dt));
 
    // Only the frozen liquid saturation S_fr is treated as temperature
    // dependent here; the porosity and the phase properties are assumed to be
    // temperature independent, so their temperature derivatives are omitted.
    return phi * (prop_value_frozen - prop_value_liquid) * dS_fr_dT;
}

References MaterialPropertyLib::frozen_liquid_saturation, OGS_FATAL, MaterialPropertyLib::porosity, properties_, MaterialPropertyLib::saturation, MaterialPropertyLib::Property::scale_, and MaterialPropertyLib::temperature.

◆ setProperties()

void MaterialPropertyLib::VolumeFractionAverage::setProperties ( std::vector< std::unique_ptr< Phase > > const & phases )

overridevirtual

Default implementation:

This virtual method will collect the properties of the phases in order to access them from the medium property level.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 29 of file VolumeFractionAverage.cpp.

{
    // run over phases, identify them and get properties
    for (auto const& phase : phases)
    {
        if (phase == nullptr)
        {
            OGS_FATAL(
                "One of the required phases (AqueousLiquid/FrozenLiquid/Solid) "
                "does not exist!");
        }
 
        if (!phase->hasProperty(prop_type_))
        {
            OGS_FATAL(
                "The phase '{}' does not have the required property '{}'!",
                toString(phase->phaseName),
                property_enum_to_string[prop_type_]);
        }
        auto const& property = phase->property(prop_type_);
        if (phase->phaseName == PhaseName::AqueousLiquid)
        {
            properties_.liquid = &property;
        }
        else if (phase->phaseName == PhaseName::FrozenLiquid)
        {
            properties_.frozen = &property;
        }
        else if (phase->phaseName == PhaseName::Solid)
        {
            properties_.porous = &property;
        }
    }
 
    // Consistency check performed once at setup (scale_ is already set to the
    // medium by setScale() before setProperties() runs), instead of on every
    // value()/dValue() call: a FrozenLiquid phase providing this property and
    // the medium's frozen_liquid_saturation property must either both be
    // present or both be absent.
    auto const& medium = *std::get<Medium*>(scale_);
    if ((properties_.frozen != nullptr) !=
        medium.hasProperty(PropertyType::frozen_liquid_saturation))
    {
        OGS_FATAL(
            "In the 'VolumeFractionAverage' property '{}', a FrozenLiquid "
            "phase "
            "and the medium's 'frozen_liquid_saturation' property must be "
            "provided together. Found FrozenLiquid phase property: {}, medium "
            "frozen_liquid_saturation property: {}.",
            name_, properties_.frozen != nullptr,
            medium.hasProperty(PropertyType::frozen_liquid_saturation));
    }
}

References MaterialPropertyLib::AqueousLiquid, MaterialPropertyLib::frozen_liquid_saturation, MaterialPropertyLib::FrozenLiquid, MaterialPropertyLib::Property::name_, OGS_FATAL, prop_type_, properties_, MaterialPropertyLib::property_enum_to_string, MaterialPropertyLib::Property::scale_, MaterialPropertyLib::Solid, and MaterialPropertyLib::toString().

◆ value()

PropertyDataType MaterialPropertyLib::VolumeFractionAverage::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 84 of file VolumeFractionAverage.cpp.

{
    auto const& medium = *std::get<Medium*>(scale_);
    auto const& porosity = medium[PropertyType::porosity];
 
    auto const phi =
        std::get<double>(porosity.value(variable_array, pos, t, dt));
 
    double S_fr = 0;
    double prop_value_frozen = 0;
 
    // get frozen liquid (ice) saturation, i.e. the fraction of the pore space
    // occupied by ice (the frozen-phase/saturation consistency is enforced once
    // in setProperties())
    if (medium.hasProperty(PropertyType::frozen_liquid_saturation))
    {
        auto const& saturation = medium[PropertyType::frozen_liquid_saturation];
        S_fr = std::get<double>(saturation.value(variable_array, pos, t, dt));
        prop_value_frozen = std::get<double>(
            properties_.frozen->value(variable_array, pos, t, dt));
    }
    auto const prop_value_liquid =
        std::get<double>(properties_.liquid->value(variable_array, pos, t, dt));
    auto const prop_value_porous =
        std::get<double>(properties_.porous->value(variable_array, pos, t, dt));
 
    return phi * (1.0 - S_fr) * prop_value_liquid +
           phi * S_fr * prop_value_frozen + (1 - phi) * prop_value_porous;
}

References MaterialPropertyLib::frozen_liquid_saturation, MaterialPropertyLib::porosity, properties_, MaterialPropertyLib::saturation, and MaterialPropertyLib::Property::scale_.

Member Data Documentation

◆ prop_type_

PropertyType MaterialPropertyLib::VolumeFractionAverage::prop_type_

protected

Definition at line 70 of file VolumeFractionAverage.h.

Referenced by VolumeFractionAverage(), and setProperties().

◆ properties_

PhaseProperties MaterialPropertyLib::VolumeFractionAverage::properties_

protected

Definition at line 71 of file VolumeFractionAverage.h.

Referenced by dValue(), setProperties(), and value().

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

Detailed Description

Classes

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ VolumeFractionAverage()

Member Function Documentation

◆ checkScale()

◆ dValue()

◆ setProperties()

◆ value()

Member Data Documentation

◆ prop_type_

◆ properties_