Detailed Description

The Penman-Millington-Quirk (PMQ) Vapour diffusion model.

The model was presented in [7]

The vapour diffusion can be described by [20], [21], [7]

\[ D_v=2.16\cdot 10^{-5} \left(\frac{T}{273.15}\right)^{1.8} D_{vr}, \]

where \(D_{vr}\) is the the relative diffusion coefficient, and \(T\) is the temperature.

In the PMQ type, \(D_{vr}\) takes the form of [7]

\[ D_{vr}=0.66 \phi (1 - S_L )^2, \]

with \(\phi\), the porosity, \(S_L\), the water saturation, \(0.66\) the tortuosity constant.

Definition at line 44 of file VapourDiffusionPMQ.h.

#include <VapourDiffusionPMQ.h>

Inheritance diagram for MaterialPropertyLib::VapourDiffusionPMQ:

[legend]

Collaboration diagram for MaterialPropertyLib::VapourDiffusionPMQ:

[legend]

Public Member Functions
	VapourDiffusionPMQ (std::string name)

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. 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

Static Private Attributes
static constexpr double	tortuosity_ = 0.66

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

◆ VapourDiffusionPMQ()

MaterialPropertyLib::VapourDiffusionPMQ::VapourDiffusionPMQ ( std::string name )

inlineexplicit

Definition at line 47 of file VapourDiffusionPMQ.h.

47 { name_ = std::move(name); }

MaterialPropertyLib::Property::name_

std::string name_

Definition: Property.h:280

MaterialPropertyLib::name

@ name

Definition: PropertyType.h:65

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

Member Function Documentation

◆ checkScale()

void MaterialPropertyLib::VapourDiffusionPMQ::checkScale ( ) const

inlineoverridevirtual

Reimplemented from MaterialPropertyLib::Property.

Definition at line 49 of file VapourDiffusionPMQ.h.

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

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

◆ dValue()

PropertyDataType MaterialPropertyLib::VapourDiffusionPMQ::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 47 of file VapourDiffusionPMQ.cpp.

 {
     const double S_L = std::clamp(
         std::get<double>(
             variable_array[static_cast<int>(Variable::liquid_saturation)]),
         0.0, 1.0);
  
     const double T = std::get<double>(
         variable_array[static_cast<int>(Variable::temperature)]);
     const double phi =
         std::get<double>(variable_array[static_cast<int>(Variable::porosity)]);
  
     if (variable == Variable::temperature)
     {
         const double S_v = 1 - S_L;
         const double D_vr = tortuosity_ * phi * S_v * S_v;
  
         return 1.8 * 2.16e-5 *
                std::pow(T / MaterialLib::PhysicalConstant::CelsiusZeroInKelvin,
                         0.8) *
                D_vr / MaterialLib::PhysicalConstant::CelsiusZeroInKelvin;
     }
  
     if (variable == Variable::liquid_saturation)
     {
         return -2.16e-5 *
                std::pow(T / MaterialLib::PhysicalConstant::CelsiusZeroInKelvin,
                         1.8) *
                2.0 * tortuosity_ * phi * S_L;
     }
  
     OGS_FATAL(
         "VapourDiffusionPMQ::dValue is implemented for "
         "derivatives with respect to temperature or saturation only.");
 }

References MaterialLib::PhysicalConstant::CelsiusZeroInKelvin, MaterialPropertyLib::liquid_saturation, OGS_FATAL, MaterialPropertyLib::porosity, MaterialPropertyLib::temperature, and tortuosity_.

◆ value()

PropertyDataType MaterialPropertyLib::VapourDiffusionPMQ::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 23 of file VapourDiffusionPMQ.cpp.

 {
     const double S_L = std::clamp(
         std::get<double>(
             variable_array[static_cast<int>(Variable::liquid_saturation)]),
         0.0, 1.0);
  
     const double T = std::get<double>(
         variable_array[static_cast<int>(Variable::temperature)]);
     const double phi =
         std::get<double>(variable_array[static_cast<int>(Variable::porosity)]);
  
     const double S_v = 1 - S_L;
     const double D_vr = tortuosity_ * phi * S_v * S_v;
  
     return 2.16e-5 *
            std::pow(T / MaterialLib::PhysicalConstant::CelsiusZeroInKelvin,
                     1.8) *
            D_vr;
 }

References MaterialLib::PhysicalConstant::CelsiusZeroInKelvin, MaterialPropertyLib::liquid_saturation, MaterialPropertyLib::porosity, MaterialPropertyLib::temperature, and tortuosity_.

Member Data Documentation

◆ tortuosity_

constexpr double MaterialPropertyLib::VapourDiffusionPMQ::tortuosity_ = 0.66

staticconstexprprivate

Definition at line 70 of file VapourDiffusionPMQ.h.

Referenced by dValue(), and value().

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

MaterialLib/MPL/Properties/VapourDiffusion/VapourDiffusionPMQ.h
MaterialLib/MPL/Properties/VapourDiffusion/VapourDiffusionPMQ.cpp

Detailed Description

Public Member Functions

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ VapourDiffusionPMQ()

Member Function Documentation

◆ checkScale()

◆ dValue()

◆ value()

Member Data Documentation

◆ tortuosity_