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 >:

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

  : PorousFlowRelativePermeabilityBaseTempl<is_ad>(parameters),
    _lambda(this->template getParam<Real>("lambda")),
    _is_nonwetting(this->template getParam<bool>("nw_phase"))
{
}

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 PorousFlowRelativePermeabilityBCTempl< 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 48 of file PorousFlowRelativePermeabilityBC.C.

{
  if (_is_nonwetting)
    return PorousFlowBrooksCorey::dRelativePermeabilityNW(seff, _lambda);
  else
    return PorousFlowBrooksCorey::dRelativePermeabilityW(seff, _lambda);
}

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 > PorousFlowRelativePermeabilityBCTempl< 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 38 of file PorousFlowRelativePermeabilityBC.C.

{
  if (_is_nonwetting)
    return PorousFlowBrooksCorey::relativePermeabilityNW(seff, _lambda);
  else
    return PorousFlowBrooksCorey::relativePermeabilityW(seff, _lambda);
}

validParams()

template<bool is_ad>

InputParameters PorousFlowRelativePermeabilityBCTempl< is_ad >::validParams ( )

static

Definition at line 18 of file PorousFlowRelativePermeabilityBC.C.

{
  InputParameters params = PorousFlowRelativePermeabilityBaseTempl<is_ad>::validParams();
  params.addRequiredParam<Real>("lambda", "The Brooks-Corey exponent of the phase");
  params.addParam<bool>("nw_phase", false, "Set true if this is the non-wetting phase");
  params.addClassDescription("Brooks-Corey relative permeability");
  return params;
}

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:

• porous_flow/include/materials/PorousFlowRelativePermeabilityBC.h
• porous_flow/src/materials/PorousFlowRelativePermeabilityBC.C