Material to calculate van Genuchten-type relative permeability of an arbitrary phase given the saturation and exponent of that phase. More...

#include <PorousFlowRelativePermeabilityVG.h>

Inheritance diagram for PorousFlowRelativePermeabilityVGTempl< is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowRelativePermeabilityVGTempl (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual GenericReal< is_ad >	relativePermeability (GenericReal< is_ad > seff) const override
	Relative permeability equation (must be overriden in derived class)

virtual Real	dRelativePermeability (Real seff) const override
	Derivative of relative permeability with respect to effective saturation.

virtual void	computeQpProperties () override

virtual GenericReal< is_ad >	effectiveSaturation (GenericReal< is_ad > saturation) const
	Effective saturation of fluid phase.

Protected Attributes
const Real	_m
	van Genuchten exponent m for the specified phase

const bool	_wetting
	Whether to use the wetting or non-wetting van Genuchten expression.

const Real	_cut
	Start of cubic smoothing.

const Real	_cub0
	Parameter of the cubic.

const Real	_cub1
	Parameter of the cubic.

const Real	_cub2
	Parameter of the cubic.

const Real	_cub3
	Parameter of the cubic.

const Real	_scaling
	Relative permeability is multiplied by this quantity.

const GenericMaterialProperty< std::vector< Real >, is_ad > &	_saturation
	Saturation material property.

GenericMaterialProperty< Real, is_ad > &	_relative_permeability
	Relative permeability material property.

MaterialProperty< Real > *const	_drelative_permeability_ds
	Derivative of relative permeability wrt phase saturation.

const Real	_s_res
	Residual saturation of specified phase.

const Real	_sum_s_res
	Sum of residual saturations over all phases.

const Real	_dseff_ds
	Derivative of effective saturation with respect to saturation.

const unsigned int	_phase_num
	Phase number of fluid.

const std::string	_phase
	Stringified fluid phase number.

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

template<bool is_ad>
class PorousFlowRelativePermeabilityVGTempl< is_ad >

Material to calculate van Genuchten-type relative permeability of an arbitrary phase given the saturation and exponent of that phase.

From van Genuchten, M. Th., A closed for equation for predicting the hydraulic conductivity of unsaturated soils, Soil Sci. Soc., 44, 892-898 (1980)

Optionally this relative permeability may be smoothed with a cubic near seff=1 The relative permeability is a cubic for seff>_cut. The cubic is chosen so that the derivative is zero for seff=1, and that the derivative and value matches the van Genuchten expression for seff=_cut.

Definition at line 28 of file PorousFlowRelativePermeabilityVG.h.

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityVGTempl()

template<bool is_ad>

PorousFlowRelativePermeabilityVGTempl< is_ad >::PorousFlowRelativePermeabilityVGTempl ( const InputParameters & parameters )

Definition at line 42 of file PorousFlowRelativePermeabilityVG.C.

  : PorousFlowRelativePermeabilityBaseTempl<is_ad>(parameters),
    _m(this->template getParam<Real>("m")),
    _wetting(this->template getParam<bool>("wetting")),
    _cut(this->template getParam<Real>("seff_turnover")),
    _cub0(_wetting ? PorousFlowVanGenuchten::relativePermeability(_cut, _m)
                   : PorousFlowVanGenuchten::relativePermeabilityNW(_cut, _m)),
    _cub1(_wetting ? PorousFlowVanGenuchten::dRelativePermeability(_cut, _m)
                   : PorousFlowVanGenuchten::dRelativePermeabilityNW(_cut, _m)),
    _cub2(_cut < 1.0
              ? (this->template getParam<bool>("zero_derivative")
                     ? 3.0 * (1.0 - _cub0 - _cub1 * (1.0 - _cut)) / Utility::pow<2>(1.0 - _cut) +
                           _cub1 / (1.0 - _cut)
                     : (_wetting ? PorousFlowVanGenuchten::d2RelativePermeability(_cut, _m)
                                 : PorousFlowVanGenuchten::d2RelativePermeabilityNW(_cut, _m)))
              : 0.0),
    _cub3(_cut < 1.0
              ? (this->template getParam<bool>("zero_derivative")
                     ? -2.0 * (1.0 - _cub0 - _cub1 * (1.0 - _cut)) / Utility::pow<3>(1.0 - _cut) -
                           _cub1 / Utility::pow<2>(1.0 - _cut)
                     : (1.0 - _cub0 - _cub1 * (1.0 - _cut) - _cub2 * Utility::pow<2>(1.0 - _cut)) /
                           Utility::pow<3>(1.0 - _cut))
              : 0.0)
{
}

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>

void PorousFlowRelativePermeabilityBaseTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtualinherited

Definition at line 65 of file PorousFlowRelativePermeabilityBase.C.

{
  // Effective saturation
  GenericReal<is_ad> seff = effectiveSaturation(_saturation[_qp][_phase_num]);
  GenericReal<is_ad> relperm;
  Real drelperm;
 
  if (seff < 0.0)
  {
    // Relative permeability is 0 for saturation less than residual
    relperm = 0.0;
    drelperm = 0.0;
  }
  else if (seff >= 0.0 && seff <= 1)
  {
    relperm = relativePermeability(seff);
    drelperm = dRelativePermeability(MetaPhysicL::raw_value(seff));
  }
  else // seff > 1
  {
    // Relative permeability is 1 when fully saturated
    relperm = 1.0;
    drelperm = 0.0;
  }
 
  _relative_permeability[_qp] = relperm * _scaling;
 
  if (!is_ad)
    (*_drelative_permeability_ds)[_qp] = drelperm * _dseff_ds * _scaling;
}

◆ dRelativePermeability()

template<bool is_ad>

Real PorousFlowRelativePermeabilityVGTempl< is_ad >::dRelativePermeability ( Real seff ) const

overrideprotectedvirtual

Derivative of relative permeability with respect to effective saturation.

Parameters

seff	effective saturation

Returns: derivative of relative permeability wrt effective saturation

Implements PorousFlowRelativePermeabilityBaseTempl< is_ad >.

Definition at line 87 of file PorousFlowRelativePermeabilityVG.C.

{
  if (seff < _cut)
  {
    if (_wetting)
      return PorousFlowVanGenuchten::dRelativePermeability(seff, _m);
    else
      return PorousFlowVanGenuchten::dRelativePermeabilityNW(seff, _m);
  }
 
  return _cub1 + 2.0 * _cub2 * (seff - _cut) + 3.0 * _cub3 * Utility::pow<2>(seff - _cut);
}

◆ effectiveSaturation()

template<bool is_ad>

GenericReal< is_ad > PorousFlowRelativePermeabilityBaseTempl< is_ad >::effectiveSaturation ( GenericReal< is_ad > saturation ) const

protectedvirtualinherited

Effective saturation of fluid phase.

Parameters

saturation true saturation

Returns: effective saturation

Definition at line 98 of file PorousFlowRelativePermeabilityBase.C.

{
  return (saturation - _s_res) / (1.0 - _sum_s_res);
}

◆ relativePermeability()

template<bool is_ad>

GenericReal< is_ad > PorousFlowRelativePermeabilityVGTempl< is_ad >::relativePermeability ( GenericReal< is_ad > seff ) const

overrideprotectedvirtual

Relative permeability equation (must be overriden in derived class)

Parameters

seff	effective saturation

Returns: relative permeability

Implements PorousFlowRelativePermeabilityBaseTempl< is_ad >.

Definition at line 71 of file PorousFlowRelativePermeabilityVG.C.

{
  if (MetaPhysicL::raw_value(seff) < _cut)
  {
    if (_wetting)
      return PorousFlowVanGenuchten::relativePermeability(seff, _m);
    else
      return PorousFlowVanGenuchten::relativePermeabilityNW(seff, _m);
  }
 
  return _cub0 + _cub1 * (seff - _cut) + _cub2 * Utility::pow<2>(seff - _cut) +
         _cub3 * Utility::pow<3>(seff - _cut);
}

◆ validParams()

template<bool is_ad>

InputParameters PorousFlowRelativePermeabilityVGTempl< is_ad >::validParams ( )

static

Definition at line 18 of file PorousFlowRelativePermeabilityVG.C.

{
  InputParameters params = PorousFlowRelativePermeabilityBaseTempl<is_ad>::validParams();
  params.addRequiredRangeCheckedParam<Real>(
      "m", "m > 0 & m < 1", "The van Genuchten exponent of the phase");
  params.addRangeCheckedParam<Real>("seff_turnover",
                                    1.0,
                                    "seff_turnover > 0 & seff_turnover <= 1",
                                    "The relative permeability will be a cubic for seff > "
                                    "seff_turnover.  The cubic is chosen so that its derivative "
                                    "and value matche the VG function at seff=seff_turnover");
  params.addParam<bool>("zero_derivative",
                        false,
                        "Employ a cubic for seff>seff_turnover that has zero derivative at seff=1");
  params.addParam<bool>("wetting",
                        true,
                        "If true, use the van Genuchten form appropriate for a wetting (liquid) "
                        "phase.  If false, use the non-wetting (gas) expression.");
  params.addClassDescription("This Material calculates relative permeability of a phase "
                             "using the van Genuchten model");
  return params;
}