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

#include <PorousFlowHystereticRelativePermeabilityLiquid.h>

Inheritance diagram for PorousFlowHystereticRelativePermeabilityLiquid:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowHystereticRelativePermeabilityLiquid (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	computeTurningPoint0Info (Real tp_sat) override
	Compute all relevant quantities at the zeroth turning point (the transition from primary drying to first-order wetting) More...

virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

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

const Real	_liquid_modification_range
	Wetting liquid relative permeability is a cubic between liquid_modification_range * (1 - _s_gr_tp0) and (1 - 0.5 * _s_gr_tp0), where _s_gr_tp0 is the Land expression resulting from the saturation at the turning point from primary drying to first-order wetting. More...

MaterialProperty< Real > &	_kl_begin
	Computed value of the liquid wetting relative permeability at liquid_modification_range * (1 - _s_gr_tp0) More...

MaterialProperty< Real > &	_klp_begin
	Computed derivative of the liquid wetting relative permeability at liquid_modification_range * (1 - _s_gr_tp0) More...

MaterialProperty< Real > &	_kl_end
	Computed value of the liquid wetting relative permeability at 1 - 0.5 * _s_gr_tp0. More...

MaterialProperty< Real > &	_klp_end
	Computed derivative of the liquid wetting relative permeability at 1 - 0.5 * _s_gr_tp0. 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 liquid relative permeability for 1-phase and 2-phase hysteretic models.

Definition at line 17 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Constructor & Destructor Documentation

◆ PorousFlowHystereticRelativePermeabilityLiquid()

PorousFlowHystereticRelativePermeabilityLiquid::PorousFlowHystereticRelativePermeabilityLiquid ( const InputParameters & parameters )

Definition at line 32 of file PorousFlowHystereticRelativePermeabilityLiquid.C.

   : PorousFlowHystereticRelativePermeabilityBase(parameters),
     _liquid_phase(_phase_num),
     _liquid_modification_range(getParam<Real>("liquid_modification_range")),
     _kl_begin(_nodal_material ? declareProperty<Real>("PorousFlow_hysteresis_kr_l_begin_nodal")
                               : declareProperty<Real>("PorousFlow_hysteresis_kr_l_begin_qp")),
     _klp_begin(_nodal_material ? declareProperty<Real>("PorousFlow_hysteresis_krp_l_begin_nodal")
                                : declareProperty<Real>("PorousFlow_hysteresis_krp_l_begin_qp")),
     _kl_end(_nodal_material ? declareProperty<Real>("PorousFlow_hysteresis_kr_l_end_nodal")
                             : declareProperty<Real>("PorousFlow_hysteresis_kr_l_end_qp")),
     _klp_end(_nodal_material ? declareProperty<Real>("PorousFlow_hysteresis_krp_l_end_nodal")
                              : declareProperty<Real>("PorousFlow_hysteresis_krp_l_end_qp"))
 {
 }

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 PorousFlowHystereticRelativePermeabilityLiquid::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 49 of file PorousFlowHystereticRelativePermeabilityLiquid.C.

 {
   const Real sl = _saturation[_qp][_liquid_phase];
 
   if (_hys_order[_qp] == 0)
   {
     _relative_permeability[_qp] = PorousFlowVanGenuchten::relativePermeabilityHys(
         sl, _s_lr, 0.0, _s_gr_max, 1.0, _m, _liquid_modification_range, 0.0, 0.0, 0.0, 0.0);
     _drelative_permeability_ds[_qp] = PorousFlowVanGenuchten::drelativePermeabilityHys(
         sl, _s_lr, 0.0, _s_gr_max, 1.0, _m, _liquid_modification_range, 0.0, 0.0, 0.0, 0.0);
   }
   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::relativePermeabilityHys(sl,
                                                         _s_lr,
                                                         s_gas_max,
                                                         _s_gr_max,
                                                         effective_liquid_tp,
                                                         _m,
                                                         _liquid_modification_range,
                                                         _kl_begin[_qp],
                                                         _klp_begin[_qp],
                                                         _kl_end[_qp],
                                                         _klp_end[_qp]);
     _drelative_permeability_ds[_qp] =
         PorousFlowVanGenuchten::drelativePermeabilityHys(sl,
                                                          _s_lr,
                                                          s_gas_max,
                                                          _s_gr_max,
                                                          effective_liquid_tp,
                                                          _m,
                                                          _liquid_modification_range,
                                                          _kl_begin[_qp],
                                                          _klp_begin[_qp],
                                                          _kl_end[_qp],
                                                          _klp_end[_qp]);
   }
 }

◆ computeTurningPoint0Info()

void PorousFlowHystereticRelativePermeabilityLiquid::computeTurningPoint0Info ( Real tp_sat )

overrideprotectedvirtual

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

Definition at line 97 of file PorousFlowHystereticRelativePermeabilityLiquid.C.

 {
   PorousFlowHystereticRelativePermeabilityBase::computeTurningPoint0Info(tp_sat);
 
   // following ternaries deal 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 = (tp_sat < _s_lr) ? _s_lr : tp_sat;
   const Real s_gas_max = (tp_sat < _s_lr) ? _s_gr_max : _s_gr_tp0[_qp];
 
   // compute and record the wetting-curve value and derivative at s_begin
   const Real s_begin = _liquid_modification_range * (1.0 - s_gas_max);
   _kl_begin[_qp] = PorousFlowVanGenuchten::relativePermeabilityHys(s_begin,
                                                                    _s_lr,
                                                                    s_gas_max,
                                                                    _s_gr_max,
                                                                    effective_liquid_tp,
                                                                    _m,
                                                                    _liquid_modification_range,
                                                                    0.0,
                                                                    0.0,
                                                                    0.0,
                                                                    0.0);
   _klp_begin[_qp] = PorousFlowVanGenuchten::drelativePermeabilityHys(s_begin,
                                                                      _s_lr,
                                                                      s_gas_max,
                                                                      _s_gr_max,
                                                                      effective_liquid_tp,
                                                                      _m,
                                                                      _liquid_modification_range,
                                                                      0.0,
                                                                      0.0,
                                                                      0.0,
                                                                      0.0);
   // compute and record the drying curve information at s_end (the drying curve is used because
   // s_end = 1.0 - 0.5 * s_gas_max in PorousFlowVanGenuchten::relativePermeabilityHys)
   const Real s_end = 1.0 - 0.5 * s_gas_max;
   _kl_end[_qp] = PorousFlowVanGenuchten::relativePermeabilityHys(s_end,
                                                                  _s_lr,
                                                                  s_gas_max,
                                                                  _s_gr_max,
                                                                  effective_liquid_tp,
                                                                  _m,
                                                                  _liquid_modification_range,
                                                                  0.0,
                                                                  0.0,
                                                                  0.0,
                                                                  0.0);
   _klp_end[_qp] = PorousFlowVanGenuchten::drelativePermeabilityHys(s_end,
                                                                    _s_lr,
                                                                    s_gas_max,
                                                                    _s_gr_max,
                                                                    effective_liquid_tp,
                                                                    _m,
                                                                    _liquid_modification_range,
                                                                    0.0,
                                                                    0.0,
                                                                    0.0,
                                                                    0.0);
 }

◆ 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 PorousFlowHystereticRelativePermeabilityLiquid::validParams ( )

static

Definition at line 16 of file PorousFlowHystereticRelativePermeabilityLiquid.C.

 {
   InputParameters params = PorousFlowHystereticRelativePermeabilityBase::validParams();
   params.addRangeCheckedParam<Real>(
       "liquid_modification_range",
       0.9,
       "liquid_modification_range > 0 & liquid_modification_range <= 1",
       "The wetting liquid relative permeability will be a cubic between S_l = "
       "liquid_modification_range * (1 - S_gr_Del) and S_l = 1.0 - 0.5 * S_gr_Del");
   params.addClassDescription(
       "PorousFlow material that computes relative permeability of the liquid phase in 1-phase or "
       "2-phase models that include hysteresis.  You should ensure that the 'phase' for this "
       "Material does indeed represent the liquid phase");
   return params;
 }

Member Data Documentation

◆ _drelative_permeability_ds

MaterialProperty<Real>& PorousFlowHystereticRelativePermeabilityBase::_drelative_permeability_ds

protectedinherited

Derivative of relative permeability wrt the saturation of _phase_num (which is not necessarily the liquid phase)

Definition at line 52 of file PorousFlowHystereticRelativePermeabilityBase.h.

Referenced by PorousFlowHystereticRelativePermeabilityGas::computeRelPermQp(), and computeRelPermQp().

◆ _hys_order

const MaterialProperty<unsigned>& PorousFlowHystereticRelativePermeabilityBase::_hys_order

protectedinherited

Hysteresis order, as computed by PorousFlowHysteresisOrder.

Definition at line 39 of file PorousFlowHystereticRelativePermeabilityBase.h.

Referenced by PorousFlowHystereticRelativePermeabilityBase::computeQpProperties(), PorousFlowHystereticRelativePermeabilityGas::computeRelPermQp(), computeRelPermQp(), and PorousFlowHystereticRelativePermeabilityBase::initQpStatefulProperties().

◆ _hys_order_old

const MaterialProperty<unsigned>& PorousFlowHystereticRelativePermeabilityBase::_hys_order_old

protectedinherited

Old value of hysteresis order, as computed by PorousFlowHysteresisOrder.

Definition at line 42 of file PorousFlowHystereticRelativePermeabilityBase.h.

Referenced by PorousFlowHystereticRelativePermeabilityBase::computeQpProperties().

◆ _hys_sat_tps

const MaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER> >& PorousFlowHystereticRelativePermeabilityBase::_hys_sat_tps

protectedinherited

Saturation values at the turning points, as computed by PorousFlowHysteresisOrder.

Definition at line 46 of file PorousFlowHystereticRelativePermeabilityBase.h.

Referenced by PorousFlowHystereticRelativePermeabilityBase::computeQpProperties(), PorousFlowHystereticRelativePermeabilityGas::computeRelPermQp(), computeRelPermQp(), and PorousFlowHystereticRelativePermeabilityBase::initQpStatefulProperties().

◆ _kl_begin

MaterialProperty<Real>& PorousFlowHystereticRelativePermeabilityLiquid::_kl_begin

protected

Computed value of the liquid wetting relative permeability at liquid_modification_range * (1 - _s_gr_tp0)

Definition at line 33 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Referenced by computeRelPermQp(), and computeTurningPoint0Info().

◆ _kl_end

MaterialProperty<Real>& PorousFlowHystereticRelativePermeabilityLiquid::_kl_end

protected

Computed value of the liquid wetting relative permeability at 1 - 0.5 * _s_gr_tp0.

Definition at line 39 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Referenced by computeRelPermQp(), and computeTurningPoint0Info().

◆ _klp_begin

MaterialProperty<Real>& PorousFlowHystereticRelativePermeabilityLiquid::_klp_begin

protected

Computed derivative of the liquid wetting relative permeability at liquid_modification_range * (1 - _s_gr_tp0)

Definition at line 36 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Referenced by computeRelPermQp(), and computeTurningPoint0Info().

◆ _klp_end

MaterialProperty<Real>& PorousFlowHystereticRelativePermeabilityLiquid::_klp_end

protected

Computed derivative of the liquid wetting relative permeability at 1 - 0.5 * _s_gr_tp0.

Definition at line 42 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Referenced by computeRelPermQp(), and computeTurningPoint0Info().

◆ _liquid_modification_range

const Real PorousFlowHystereticRelativePermeabilityLiquid::_liquid_modification_range

protected

Wetting liquid relative permeability is a cubic between liquid_modification_range * (1 - _s_gr_tp0) and (1 - 0.5 * _s_gr_tp0), where _s_gr_tp0 is the Land expression resulting from the saturation at the turning point from primary drying to first-order wetting.

Definition at line 30 of file PorousFlowHystereticRelativePermeabilityLiquid.h.

Referenced by computeRelPermQp(), and computeTurningPoint0Info().