MaterialPropertyLib::TransportPorosityFromMassBalance Class Reference

Detailed Description

Porosity depending on the volumetric strain rate and phase pressure rate.

This property must be a solid phase.

Definition at line 24 of file TransportPorosityFromMassBalance.h.

#include <TransportPorosityFromMassBalance.h>

Inheritance diagram for MaterialPropertyLib::TransportPorosityFromMassBalance:

Collaboration diagram for MaterialPropertyLib::TransportPorosityFromMassBalance:

Public Member Functions
	TransportPorosityFromMassBalance (std::string name, ParameterLib::Parameter< double > const &initial_porosity, double const phi_min, double const phi_max)
void	checkScale () const override
PropertyDataType	initialValue (ParameterLib::SpatialPosition const &pos, double const t) const override
PropertyDataType	value (VariableArray const &variable_array, ParameterLib::SpatialPosition const &pos, double const t, double const dt) 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, 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	value () 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 &	phi0_
	Parameter, which is used by FEM to set the initial porosity value.
double const	phi_min_
double const	phi_max_

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

TransportPorosityFromMassBalance()

MaterialPropertyLib::TransportPorosityFromMassBalance::TransportPorosityFromMassBalance ( std::string name, ParameterLib::Parameter< double > const & initial_porosity, double const phi_min, double const phi_max )

inline

Definition at line 33 of file TransportPorosityFromMassBalance.h.

        : phi0_(initial_porosity), phi_min_(phi_min), phi_max_(phi_max)
    {
        name_ = std::move(name);
    }

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

Member Function Documentation

checkScale()

void MaterialPropertyLib::TransportPorosityFromMassBalance::checkScale ( ) const

overridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 19 of file TransportPorosityFromMassBalance.cpp.

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

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

dValue()

PropertyDataType MaterialPropertyLib::TransportPorosityFromMassBalance::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 67 of file TransportPorosityFromMassBalance.cpp.

{
    OGS_FATAL(
        "TransportPorosityFromMassBalance derivatives are not implemented.");
}

References OGS_FATAL.

initialValue()

PropertyDataType MaterialPropertyLib::TransportPorosityFromMassBalance::initialValue ( ParameterLib::SpatialPosition const & pos, double const t ) const

inlineoverridevirtual

Returns the initial (or reference) value of the property. The default implementation forwards to the value function.

Reimplemented from MaterialPropertyLib::Property.

Definition at line 44 of file TransportPorosityFromMassBalance.h.

    {
        return fromVector(phi0_(t, pos));
    }

References MaterialPropertyLib::fromVector(), and phi0_.

value() [1/2]

PropertyDataType MaterialPropertyLib::TransportPorosityFromMassBalance::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 57 of file TransportPorosityFromMassBalance.cpp.

{
    OGS_FATAL(
        "TransportPorosityFromMassBalance value call requires previous time "
        "step values.");
}

References OGS_FATAL.

value() [2/2]

PropertyDataType MaterialPropertyLib::TransportPorosityFromMassBalance::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 29 of file TransportPorosityFromMassBalance.cpp.

{
    double const beta_SR = variable_array.grain_compressibility;
    auto const alpha_b =
        std::get<Medium*>(scale_)
            ->property(PropertyType::biot_coefficient)
            .template value<double>(variable_array, pos, t, dt);
 
    double const e = variable_array.volumetric_strain;
    double const e_prev = variable_array_prev.volumetric_strain;
    double const delta_e = e - e_prev;
 
    double const p_eff = variable_array.effective_pore_pressure;
    double const p_eff_prev = variable_array_prev.effective_pore_pressure;
    double const delta_p_eff = p_eff - p_eff_prev;
 
    double const phi = variable_array.porosity;
 
    double const phi_tr_prev = variable_array_prev.transport_porosity;
 
    double const w = delta_e + delta_p_eff * beta_SR;
    return std::clamp(phi_tr_prev + (alpha_b - phi) * w, phi_min_, phi_max_);
}

References MaterialPropertyLib::biot_coefficient, MaterialPropertyLib::VariableArray::effective_pore_pressure, MaterialPropertyLib::VariableArray::grain_compressibility, phi_max_, phi_min_, MaterialPropertyLib::VariableArray::porosity, MaterialPropertyLib::Property::scale_, MaterialPropertyLib::VariableArray::transport_porosity, and MaterialPropertyLib::VariableArray::volumetric_strain.

Member Data Documentation

phi0_

ParameterLib::Parameter<double> const& MaterialPropertyLib::TransportPorosityFromMassBalance::phi0_

private

Parameter, which is used by FEM to set the initial porosity value.

Definition at line 28 of file TransportPorosityFromMassBalance.h.

Referenced by initialValue().

phi_max_

double const MaterialPropertyLib::TransportPorosityFromMassBalance::phi_max_

private

Definition at line 30 of file TransportPorosityFromMassBalance.h.

Referenced by value().

phi_min_

double const MaterialPropertyLib::TransportPorosityFromMassBalance::phi_min_

private

Definition at line 29 of file TransportPorosityFromMassBalance.h.

Referenced by value().

---

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

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