Material to compute gas relative permeability for 1-phase and 2-phase hysteretic models. More...

#include <PorousFlowHystereticRelativePermeabilityGas.h>

Inheritance diagram for PorousFlowHystereticRelativePermeabilityGas:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowHystereticRelativePermeabilityGas (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 void	computeRelPermQp () override
	Compute the relative permeability and its derivative wrt the _phase_num saturation, at the quadpoints, and store the result in _relative_permeability[_qp] and _drelative_permeability_ds[_qp]. More...

virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

virtual void	computeTurningPoint0Info (Real tp_sat)
	Compute all relevant quantities at the zeroth turning point (the transition from primary drying to first-order wetting) More...

Protected Attributes
const unsigned	_liquid_phase
	Phase number of liquid phase. More...

const Real	_gamma
	gamma parameter used in the gas relative permeability More...

const Real	_k_rg_max
	Value of the gas relative permeability at liquid saturation = _s_lr. More...

const Real	_krel_gas_prime
	Value of the derivative of the cubic extension to the gas relative permeability at liquid saturation = _s_lr. More...

const Real	_s_lr
	Liquid saturation at which the liquid relperm is zero and the gas relperm is k_rg_max. More...

const Real	_s_gr_max
	Gas residual saturation. More...

const Real	_m
	van Genuchten m parameter More...

const MaterialProperty< std::vector< Real > > &	_saturation
	Saturation material property. More...

const MaterialProperty< unsigned > &	_hys_order
	Hysteresis order, as computed by PorousFlowHysteresisOrder. More...

const MaterialProperty< unsigned > &	_hys_order_old
	Old value of hysteresis order, as computed by PorousFlowHysteresisOrder. More...

const MaterialProperty< std::array< Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER > > &	_hys_sat_tps
	Saturation values at the turning points, as computed by PorousFlowHysteresisOrder. More...

MaterialProperty< Real > &	_relative_permeability
	Computed relative permeability. More...

MaterialProperty< Real > &	_drelative_permeability_ds
	Derivative of relative permeability wrt the saturation of _phase_num (which is not necessarily the liquid phase) More...

MaterialProperty< Real > &	_s_gr_tp0
	Computed nodal or quadpoint values the Land expression, at the turning point from primary drying to first-order wetting. More...

const unsigned int	_phase_num
	Phase number of fluid. More...

const std::string	_phase
	Stringified fluid phase number. More...

Detailed Description

Material to compute gas relative permeability for 1-phase and 2-phase hysteretic models.

Definition at line 17 of file PorousFlowHystereticRelativePermeabilityGas.h.

Constructor & Destructor Documentation

◆ PorousFlowHystereticRelativePermeabilityGas()

PorousFlowHystereticRelativePermeabilityGas::PorousFlowHystereticRelativePermeabilityGas ( const InputParameters & parameters )

Definition at line 43 of file PorousFlowHystereticRelativePermeabilityGas.C.

   : PorousFlowHystereticRelativePermeabilityBase(parameters),
     _liquid_phase(_phase_num == 0 ? 1 : 0),
     _gamma(getParam<Real>("gamma")),
     _k_rg_max(getParam<Real>("k_rg_max")),
     _krel_gas_prime((getParam<MooseEnum>("gas_low_extension_type") == "linear_like")
                         ? ((_s_lr > 0) ? (_k_rg_max - 1.0) / _s_lr : 0.0)
                         : PorousFlowVanGenuchten::drelativePermeabilityNWHys(
                               _s_lr, _s_lr, 0.0, _s_gr_max, 1.0, _m, _gamma, _k_rg_max, 0.0))
 {
 }

Member Function Documentation

◆ computeQpProperties()

void PorousFlowHystereticRelativePermeabilityBase::computeQpProperties ( )

overrideprotectedvirtualinherited

Definition at line 93 of file PorousFlowHystereticRelativePermeabilityBase.C.

 {
   PorousFlowMaterialBase::computeQpProperties();
 
   if (_hys_order[_qp] != _hys_order_old[_qp] && _hys_order[_qp] == 1)
     computeTurningPoint0Info(_hys_sat_tps[_qp].at(0));
 
   computeRelPermQp();
 }

◆ computeRelPermQp()

void PorousFlowHystereticRelativePermeabilityGas::computeRelPermQp ( )

overrideprotectedvirtual

Compute the relative permeability and its derivative wrt the _phase_num saturation, at the quadpoints, and store the result in _relative_permeability[_qp] and _drelative_permeability_ds[_qp].

Implements PorousFlowHystereticRelativePermeabilityBase.

Definition at line 57 of file PorousFlowHystereticRelativePermeabilityGas.C.

 {
   const Real sl = _saturation[_qp][_liquid_phase];
 
   if (_hys_order[_qp] == 0)
   {
     _relative_permeability[_qp] = PorousFlowVanGenuchten::relativePermeabilityNWHys(
         sl, _s_lr, 0.0, _s_gr_max, 1.0, _m, _gamma, _k_rg_max, _krel_gas_prime);
     // negative in the following from d(liquid_saturation)/d(gas_saturation)
     _drelative_permeability_ds[_qp] = -PorousFlowVanGenuchten::drelativePermeabilityNWHys(
         sl, _s_lr, 0.0, _s_gr_max, 1.0, _m, _gamma, _k_rg_max, _krel_gas_prime);
   }
   else
   {
     // following ternary deals with the case where the turning-point saturation occurs in the
     // low-saturation region (tp_sat < _s_lr).  There is "no hysteresis along the extension"
     // according to Doughty2008, so assume that the wetting curve is the same as would occur if
     // the turning-point saturation occured at _s_lr
     const Real effective_liquid_tp =
         (_hys_sat_tps[_qp].at(0) < _s_lr) ? _s_lr : _hys_sat_tps[_qp].at(0);
     const Real s_gas_max = (_hys_sat_tps[_qp].at(0) < _s_lr) ? _s_gr_max : _s_gr_tp0[_qp];
     _relative_permeability[_qp] =
         PorousFlowVanGenuchten::relativePermeabilityNWHys(sl,
                                                           _s_lr,
                                                           s_gas_max,
                                                           _s_gr_max,
                                                           effective_liquid_tp,
                                                           _m,
                                                           _gamma,
                                                           _k_rg_max,
                                                           _krel_gas_prime);
     // negative in the following from d(liquid_saturation)/d(gas_saturation)
     _drelative_permeability_ds[_qp] =
         -PorousFlowVanGenuchten::drelativePermeabilityNWHys(sl,
                                                             _s_lr,
                                                             s_gas_max,
                                                             _s_gr_max,
                                                             effective_liquid_tp,
                                                             _m,
                                                             _gamma,
                                                             _k_rg_max,
                                                             _krel_gas_prime);
   }
 }

◆ computeTurningPoint0Info()

void PorousFlowHystereticRelativePermeabilityBase::computeTurningPoint0Info ( Real tp_sat )

protectedvirtualinherited

Compute all relevant quantities at the zeroth turning point (the transition from primary drying to first-order wetting)

Parameters

tp_sat Liquid saturation at the turning point

Reimplemented in PorousFlowHystereticRelativePermeabilityLiquid.

Definition at line 111 of file PorousFlowHystereticRelativePermeabilityBase.C.

Referenced by PorousFlowHystereticRelativePermeabilityBase::computeQpProperties(), PorousFlowHystereticRelativePermeabilityLiquid::computeTurningPoint0Info(), and PorousFlowHystereticRelativePermeabilityBase::initQpStatefulProperties().

 {
   // s_gr_tp0 is the Land expression as a function of the zeroth turning point saturation
   _s_gr_tp0[_qp] = landSat(tp_sat);
 }

◆ initQpStatefulProperties()

void PorousFlowHystereticRelativePermeabilityBase::initQpStatefulProperties ( )

overrideprotectedvirtualinherited

Definition at line 83 of file PorousFlowHystereticRelativePermeabilityBase.C.

 {
   PorousFlowMaterialBase::initQpStatefulProperties();
   if (_hys_order[_qp] >= 1)
     computeTurningPoint0Info(_hys_sat_tps[_qp].at(0));
 
   computeRelPermQp();
 }

◆ validParams()

InputParameters PorousFlowHystereticRelativePermeabilityGas::validParams ( )

static

Definition at line 16 of file PorousFlowHystereticRelativePermeabilityGas.C.

 {
   InputParameters params = PorousFlowHystereticRelativePermeabilityBase::validParams();
   params.addRangeCheckedParam<Real>(
       "gamma", 0.33, "gamma > 0", "Gamma parameter that is used for the gas relative permeability");
   params.addRangeCheckedParam<Real>(
       "k_rg_max",
       1.0,
       "k_rg_max > 0 & k_rg_max <= 1",
       "Value of the gas relative permeability at liquid saturation = S_lr");
   MooseEnum low_ext_enum("linear_like cubic", "linear_like");
   params.addParam<MooseEnum>(
       "gas_low_extension_type",
       low_ext_enum,
       "Type of extension to use for liquid saturation < S_lr for the gas relative permeability.  "
       "All extensions employ a cubic whose value is 1.0 at liquid saturation = 0, and whose "
       "derivative is zero at liquid saturation = 0, and whose value is k_rg_max at liquid "
       "saturation = S_lr.  linear_like: the derivative at liquid_saturation = S_lr is equal to "
       "(k_rg_max - 1) / S_lr.  cubic: the derivative at liquid_saturation = S_lr equals the "
       "derivative of the unextended drying curve at that point");
   params.addClassDescription(
       "PorousFlow material that computes relative permeability of the gas phase in 1-phase or "
       "2-phase models that include hysteresis.  You should ensure that the 'phase' for this "
       "Material does indeed represent the gas phase");
   return params;
 }