This class sets a constant relative permeability. More...

#include <PorousFlowRelativePermeabilityConst.h>

Inheritance diagram for PorousFlowRelativePermeabilityConstTempl< is_ad >:

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowRelativePermeabilityConstTempl (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) More...

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

virtual void	computeQpProperties () override

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

Protected Attributes
const Real	_relperm
	Constant relative permeability. More...

const Real	_scaling
	Relative permeability is multiplied by this quantity. More...

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

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

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

const Real	_s_res
	Residual saturation of specified phase. More...

const Real	_sum_s_res
	Sum of residual saturations over all phases. More...

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

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

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

Detailed Description

template<bool is_ad>
class PorousFlowRelativePermeabilityConstTempl< is_ad >

This class sets a constant relative permeability.

This simple class is useful for testing purposes mainly

Definition at line 19 of file PorousFlowRelativePermeabilityConst.h.

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityConstTempl()

template<bool is_ad>

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

Definition at line 27 of file PorousFlowRelativePermeabilityConst.C.

   : PorousFlowRelativePermeabilityBaseTempl<is_ad>(parameters),
     _relperm(this->template getParam<Real>("kr"))
 {
 }

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 PorousFlowRelativePermeabilityConstTempl< 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 42 of file PorousFlowRelativePermeabilityConst.C.

 {
   return 0.0;
 }

◆ 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 > PorousFlowRelativePermeabilityConstTempl< 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 35 of file PorousFlowRelativePermeabilityConst.C.

 {
   return _relperm;
 }

◆ validParams()

template<bool is_ad>

InputParameters PorousFlowRelativePermeabilityConstTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowRelativePermeabilityConst.C.

 {
   InputParameters params = PorousFlowRelativePermeabilityBaseTempl<is_ad>::validParams();
   params.addParam<Real>("kr", 1.0, "Relative permeability");
   params.addClassDescription(
       "This class sets the relative permeability to a constant value (default = 1)");
   return params;
 }