Base material for computing relative permeability for 1-phase and 2-phase hysteretic models. More...

#include <PorousFlowHystereticRelativePermeabilityBase.h>

Inheritance diagram for PorousFlowHystereticRelativePermeabilityBase:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowHystereticRelativePermeabilityBase (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	initQpStatefulProperties () override

virtual void	computeQpProperties () override

virtual void	computeRelPermQp ()=0
	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)
	Compute all relevant quantities at the zeroth turning point (the transition from primary drying to first-order wetting) More...

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

Private Member Functions
Real	landSat (Real slDel) const

Detailed Description

Base material for computing relative permeability for 1-phase and 2-phase hysteretic models.

Definition at line 18 of file PorousFlowHystereticRelativePermeabilityBase.h.

Constructor & Destructor Documentation

◆ PorousFlowHystereticRelativePermeabilityBase()

PorousFlowHystereticRelativePermeabilityBase::PorousFlowHystereticRelativePermeabilityBase ( const InputParameters & parameters )

Definition at line 41 of file PorousFlowHystereticRelativePermeabilityBase.C.

   : PorousFlowMaterialBase(parameters),
     _s_lr(getParam<Real>("S_lr")),
     _s_gr_max(getParam<Real>("S_gr_max")),
     _m(getParam<Real>("m")),
     _saturation(_nodal_material
                     ? getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_nodal")
                     : getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_qp")),
     _hys_order(_nodal_material ? getMaterialProperty<unsigned>("PorousFlow_hysteresis_order_nodal")
                                : getMaterialProperty<unsigned>("PorousFlow_hysteresis_order_qp")),
     _hys_order_old(_nodal_material
                        ? getMaterialPropertyOld<unsigned>("PorousFlow_hysteresis_order_nodal")
                        : getMaterialPropertyOld<unsigned>("PorousFlow_hysteresis_order_qp")),
     _hys_sat_tps(
         _nodal_material
             ? getMaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER>>(
                   "PorousFlow_hysteresis_saturation_tps_nodal")
             : getMaterialProperty<std::array<Real, PorousFlowConstants::MAX_HYSTERESIS_ORDER>>(
                   "PorousFlow_hysteresis_saturation_tps_qp")),
     _relative_permeability(
         _nodal_material ? declareProperty<Real>("PorousFlow_relative_permeability_nodal" + _phase)
                         : declareProperty<Real>("PorousFlow_relative_permeability_qp" + _phase)),
     _drelative_permeability_ds(
         _nodal_material
             ? declarePropertyDerivative<Real>("PorousFlow_relative_permeability_nodal" + _phase,
                                               _saturation_variable_name)
             : declarePropertyDerivative<Real>("PorousFlow_relative_permeability_qp" + _phase,
                                               _saturation_variable_name)),
     _s_gr_tp0(_nodal_material
                   ? declareProperty<Real>("PorousFlow_hysteresis_s_gr_tp0_nodal" + _phase)
                   : declareProperty<Real>("PorousFlow_hysteresis_s_gr_tp0_qp" + _phase))
 {
   mooseAssert(_dictator.numPhases() <= 2,
               "PorousFlowHystereticRelativePermeability Materials can only be used for "
               "1-phase or 2-phase models.  The Dictator proclaims that the number of phases "
               "exceeds 2, and dictators are never incorrect.");
   if (_s_gr_max >= 1 - _s_lr)
     paramError("S_gr_max", "Must be less than 1 - S_lr");
 }

Member Function Documentation

◆ computeQpProperties()

void PorousFlowHystereticRelativePermeabilityBase::computeQpProperties ( )

overrideprotectedvirtual

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()

virtual void PorousFlowHystereticRelativePermeabilityBase::computeRelPermQp ( )

protectedpure virtual

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

Implemented in PorousFlowHystereticRelativePermeabilityLiquid, and PorousFlowHystereticRelativePermeabilityGas.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ computeTurningPoint0Info()

void PorousFlowHystereticRelativePermeabilityBase::computeTurningPoint0Info ( Real tp_sat )

protectedvirtual

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 computeQpProperties(), PorousFlowHystereticRelativePermeabilityLiquid::computeTurningPoint0Info(), and 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 ( )

overrideprotectedvirtual

Definition at line 83 of file PorousFlowHystereticRelativePermeabilityBase.C.

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

◆ landSat()

Real PorousFlowHystereticRelativePermeabilityBase::landSat ( Real slDel ) const

private

Returns: the value of gas saturation (called S_gr^Delta in the markdown documentation) using the Land expression. (This is a function of the liquid saturation at the turning point)

Parameters

slDel the value of the liquid saturation at the turning point

Definition at line 104 of file PorousFlowHystereticRelativePermeabilityBase.C.

Referenced by computeTurningPoint0Info().

 {
   const Real a = 1.0 / _s_gr_max - 1.0 / (1.0 - _s_lr);
   return (1.0 - slDel) / (1.0 + a * (1.0 - slDel));
 }

◆ validParams()

InputParameters PorousFlowHystereticRelativePermeabilityBase::validParams ( )

static

Definition at line 13 of file PorousFlowHystereticRelativePermeabilityBase.C.

Referenced by PorousFlowHystereticRelativePermeabilityGas::validParams(), and PorousFlowHystereticRelativePermeabilityLiquid::validParams().

 {
   InputParameters params = PorousFlowMaterialBase::validParams();
   params.addRangeCheckedParam<Real>(
       "S_lr",
       0.0,
       "S_lr >= 0 & S_lr < 1",
       "Liquid residual saturation.  At liquid saturation = S_lr, the liquid relative permeability "
       "is zero and the gas relative permeability is k_rg_max.  Almost definitely you need to set "
       "S_lr equal to the quantity used for your hysteretic capillary-pressure curve, if you are "
       "using one.");
   params.addRequiredRangeCheckedParam<Real>(
       "S_gr_max",
       "S_gr_max >= 0 & S_gr_max < 1",
       "Residual gas saturation.  For liquid saturation = 1 - S_gr_max, the gas wetting "
       "relative-permeability is zero, if the turning point was <= S_lr.  1 - S_gr_max is the "
       "maximum liquid saturation for which the van Genuchten expression is valid for the liquid "
       "relative-permeability wetting curve.  You must ensure S_gr_max < 1 - S_lr.  Often S_gr_max "
       "= -0.3136 * ln(porosity) - 0.1334 is used");
   params.addRequiredRangeCheckedParam<Real>(
       "m", "m > 0 & m < 1", "van Genuchten m parameter.  Suggested value is around 0.9");
   params.addPrivateParam<std::string>("pf_material_type", "relative_permeability");
   params.addPrivateParam<bool>("is_ad", false);
   params.addClassDescription("PorousFlow material that computes relative permeability for 1-phase "
                              "or 2-phase models that include hysteresis");
   return params;
 }