https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
PorousFlowRelativePermeabilityBCTempl< is_ad > Class Template Reference

Material to calculate Brooks-Corey relative permeability of an arbitrary phase given the effective saturation and exponent of that phase. More...

#include <PorousFlowRelativePermeabilityBC.h>

Inheritance diagram for PorousFlowRelativePermeabilityBCTempl< is_ad >:
[legend]

Public Types

typedef DerivativeMaterialPropertyNameInterface::SymbolName SymbolName
 

Public Member Functions

 PorousFlowRelativePermeabilityBCTempl (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 _lambda
 Brooks-Corey exponent lambda.
 
const bool _is_nonwetting
 Flag that is set to true if this is the non-wetting (gas) phase.
 
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 PorousFlowRelativePermeabilityBCTempl< is_ad >

Material to calculate Brooks-Corey relative permeability of an arbitrary phase given the effective saturation and exponent of that phase.

From Brooks, R. H. and A. T. Corey (1966), Properties of porous media affecting fluid flow, J. Irrig. Drain. Div., 6, 61

Definition at line 22 of file PorousFlowRelativePermeabilityBC.h.

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityBCTempl()

template<bool is_ad>
PorousFlowRelativePermeabilityBCTempl< is_ad >::PorousFlowRelativePermeabilityBCTempl ( const InputParameters &  parameters)

Definition at line 28 of file PorousFlowRelativePermeabilityBC.C.

30 : PorousFlowRelativePermeabilityBaseTempl<is_ad>(parameters),
31 _lambda(this->template getParam<Real>("lambda")),
32 _is_nonwetting(this->template getParam<bool>("nw_phase"))
33{
34}
PorousFlowRelativePermeabilityBCTempl::_lambda
const Real _lambda
Brooks-Corey exponent lambda.
Definition PorousFlowRelativePermeabilityBC.h:34
PorousFlowRelativePermeabilityBCTempl::_is_nonwetting
const bool _is_nonwetting
Flag that is set to true if this is the non-wetting (gas) phase.
Definition PorousFlowRelativePermeabilityBC.h:36
PorousFlowRelativePermeabilityBaseTempl
Base class for PorousFlow relative permeability materials.
Definition PorousFlowRelativePermeabilityBase.h:21

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>
void PorousFlowRelativePermeabilityBaseTempl< is_ad >::computeQpProperties ( )
overrideprotectedvirtualinherited

Definition at line 65 of file PorousFlowRelativePermeabilityBase.C.

66{
67 // Effective saturation
68 GenericReal<is_ad> seff = effectiveSaturation(_saturation[_qp][_phase_num]);
69 GenericReal<is_ad> relperm;
70 Real drelperm;
71
72 if (seff < 0.0)
73 {
74 // Relative permeability is 0 for saturation less than residual
75 relperm = 0.0;
76 drelperm = 0.0;
77 }
78 else if (seff >= 0.0 && seff <= 1)
79 {
80 relperm = relativePermeability(seff);
81 drelperm = dRelativePermeability(MetaPhysicL::raw_value(seff));
82 }
83 else // seff > 1
84 {
85 // Relative permeability is 1 when fully saturated
86 relperm = 1.0;
87 drelperm = 0.0;
88 }
89
90 _relative_permeability[_qp] = relperm * _scaling;
91
92 if (!is_ad)
93 (*_drelative_permeability_ds)[_qp] = drelperm * _dseff_ds * _scaling;
94}
GenericReal
Moose::GenericType< Real, is_ad > GenericReal
PorousFlowMaterialBase::_phase_num
const unsigned int _phase_num
Phase number of fluid.
Definition PorousFlowMaterialBase.h:31
PorousFlowRelativePermeabilityBaseTempl::dRelativePermeability
virtual Real dRelativePermeability(Real seff) const =0
Derivative of relative permeability with respect to effective saturation.
PorousFlowRelativePermeabilityBaseTempl::_relative_permeability
GenericMaterialProperty< Real, is_ad > & _relative_permeability
Relative permeability material property.
Definition PorousFlowRelativePermeabilityBase.h:58
PorousFlowRelativePermeabilityBaseTempl::_dseff_ds
const Real _dseff_ds
Derivative of effective saturation with respect to saturation.
Definition PorousFlowRelativePermeabilityBase.h:70
PorousFlowRelativePermeabilityBaseTempl::effectiveSaturation
virtual GenericReal< is_ad > effectiveSaturation(GenericReal< is_ad > saturation) const
Effective saturation of fluid phase.
Definition PorousFlowRelativePermeabilityBase.C:98
PorousFlowRelativePermeabilityBaseTempl::relativePermeability
virtual GenericReal< is_ad > relativePermeability(GenericReal< is_ad > seff) const =0
Relative permeability equation (must be overriden in derived class)
PorousFlowRelativePermeabilityBaseTempl::_scaling
const Real _scaling
Relative permeability is multiplied by this quantity.
Definition PorousFlowRelativePermeabilityBase.h:52
PorousFlowRelativePermeabilityBaseTempl::_saturation
const GenericMaterialProperty< std::vector< Real >, is_ad > & _saturation
Saturation material property.
Definition PorousFlowRelativePermeabilityBase.h:55
MetaPhysicL::raw_value
auto raw_value(const Eigen::Map< T > &in)
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

◆ dRelativePermeability()

template<bool is_ad>
Real PorousFlowRelativePermeabilityBCTempl< is_ad >::dRelativePermeability ( Real  seff) const
overrideprotectedvirtual

Derivative of relative permeability with respect to effective saturation.

Parameters
seffeffective saturation
Returns
derivative of relative permeability wrt effective saturation

Implements PorousFlowRelativePermeabilityBaseTempl< is_ad >.

Definition at line 48 of file PorousFlowRelativePermeabilityBC.C.

49{
50 if (_is_nonwetting)
51 return PorousFlowBrooksCorey::dRelativePermeabilityNW(seff, _lambda);
52 else
53 return PorousFlowBrooksCorey::dRelativePermeabilityW(seff, _lambda);
54}
PorousFlowBrooksCorey::dRelativePermeabilityNW
Real dRelativePermeabilityNW(Real seff, Real lambda)
Derivative of relative permeability of the non-wetting phase wrt to effective saturation.
Definition PorousFlowBrooksCorey.C:93
PorousFlowBrooksCorey::dRelativePermeabilityW
Real dRelativePermeabilityW(Real seff, Real lambda)
Derivative of relative permeability of the wetting phase wrt to effective saturation.
Definition PorousFlowBrooksCorey.C:83

◆ effectiveSaturation()

template<bool is_ad>
GenericReal< is_ad > PorousFlowRelativePermeabilityBaseTempl< is_ad >::effectiveSaturation ( GenericReal< is_ad >  saturation) const
protectedvirtualinherited

Effective saturation of fluid phase.

Parameters
saturationtrue saturation
Returns
effective saturation

Definition at line 98 of file PorousFlowRelativePermeabilityBase.C.

100{
101 return (saturation - _s_res) / (1.0 - _sum_s_res);
102}
PorousFlowRelativePermeabilityBaseTempl::_s_res
const Real _s_res
Residual saturation of specified phase.
Definition PorousFlowRelativePermeabilityBase.h:64
PorousFlowRelativePermeabilityBaseTempl::_sum_s_res
const Real _sum_s_res
Sum of residual saturations over all phases.
Definition PorousFlowRelativePermeabilityBase.h:67

◆ relativePermeability()

template<bool is_ad>
GenericReal< is_ad > PorousFlowRelativePermeabilityBCTempl< is_ad >::relativePermeability ( GenericReal< is_ad >  seff) const
overrideprotectedvirtual

Relative permeability equation (must be overriden in derived class)

Parameters
seffeffective saturation
Returns
relative permeability

Implements PorousFlowRelativePermeabilityBaseTempl< is_ad >.

Definition at line 38 of file PorousFlowRelativePermeabilityBC.C.

39{
40 if (_is_nonwetting)
41 return PorousFlowBrooksCorey::relativePermeabilityNW(seff, _lambda);
42 else
43 return PorousFlowBrooksCorey::relativePermeabilityW(seff, _lambda);
44}
PorousFlowBrooksCorey::relativePermeabilityW
T relativePermeabilityW(const T &seff, Real lambda)
Relative permeability of the wetting phase as a function of effective saturation.
Definition PorousFlowBrooksCorey.h:98
PorousFlowBrooksCorey::relativePermeabilityNW
T relativePermeabilityNW(const T &seff, Real lambda)
Relative permeability of the non-wetting phase as a function of effective saturation.
Definition PorousFlowBrooksCorey.h:125

◆ validParams()

template<bool is_ad>
InputParameters PorousFlowRelativePermeabilityBCTempl< is_ad >::validParams ( )
static

Definition at line 18 of file PorousFlowRelativePermeabilityBC.C.

19{
20 InputParameters params = PorousFlowRelativePermeabilityBaseTempl<is_ad>::validParams();
21 params.addRequiredParam<Real>("lambda", "The Brooks-Corey exponent of the phase");
22 params.addParam<bool>("nw_phase", false, "Set true if this is the non-wetting phase");
23 params.addClassDescription("Brooks-Corey relative permeability");
24 return params;
25}
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _drelative_permeability_ds

template<bool is_ad>
MaterialProperty<Real>* const PorousFlowRelativePermeabilityBaseTempl< is_ad >::_drelative_permeability_ds
protectedinherited

Derivative of relative permeability wrt phase saturation.

Definition at line 61 of file PorousFlowRelativePermeabilityBase.h.

◆ _dseff_ds

template<bool is_ad>
const Real PorousFlowRelativePermeabilityBaseTempl< is_ad >::_dseff_ds
protectedinherited

Derivative of effective saturation with respect to saturation.

Definition at line 70 of file PorousFlowRelativePermeabilityBase.h.

◆ _is_nonwetting

template<bool is_ad>
const bool PorousFlowRelativePermeabilityBCTempl< is_ad >::_is_nonwetting
protected

Flag that is set to true if this is the non-wetting (gas) phase.

Definition at line 36 of file PorousFlowRelativePermeabilityBC.h.

◆ _lambda

template<bool is_ad>
const Real PorousFlowRelativePermeabilityBCTempl< is_ad >::_lambda
protected

Brooks-Corey exponent lambda.

Definition at line 34 of file PorousFlowRelativePermeabilityBC.h.

◆ _phase

const std::string PorousFlowMaterialBase::_phase
protectedinherited

Stringified fluid phase number.

Definition at line 34 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num
protectedinherited

Phase number of fluid.

Definition at line 31 of file PorousFlowMaterialBase.h.

Referenced by PorousFlowBrine::computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), and PorousFlowMaterialBase::PorousFlowMaterialBase().

◆ _relative_permeability

template<bool is_ad>
GenericMaterialProperty<Real, is_ad>& PorousFlowRelativePermeabilityBaseTempl< is_ad >::_relative_permeability
protectedinherited

Relative permeability material property.

Definition at line 58 of file PorousFlowRelativePermeabilityBase.h.

◆ _s_res

template<bool is_ad>
const Real PorousFlowRelativePermeabilityBaseTempl< is_ad >::_s_res
protectedinherited

Residual saturation of specified phase.

Definition at line 64 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBaseTempl< is_ad >::PorousFlowRelativePermeabilityBaseTempl().

◆ _saturation

template<bool is_ad>
const GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowRelativePermeabilityBaseTempl< is_ad >::_saturation
protectedinherited

Saturation material property.

Definition at line 55 of file PorousFlowRelativePermeabilityBase.h.

◆ _scaling

template<bool is_ad>
const Real PorousFlowRelativePermeabilityBaseTempl< is_ad >::_scaling
protectedinherited

Relative permeability is multiplied by this quantity.

Definition at line 52 of file PorousFlowRelativePermeabilityBase.h.

◆ _sum_s_res

template<bool is_ad>
const Real PorousFlowRelativePermeabilityBaseTempl< is_ad >::_sum_s_res
protectedinherited

Sum of residual saturations over all phases.

Definition at line 67 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBaseTempl< is_ad >::PorousFlowRelativePermeabilityBaseTempl().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:39 for https://mooseframework.inl.gov by doxygen 1.9.8