Material that calculates the Broadbridge-White relative permeability P Broadbridge, I White `‘Constant rate rainfall infiltration: A versatile nonlinear model, 1 Analytical solution’'. More...

#include <PorousFlowRelativePermeabilityBW.h>

Inheritance diagram for PorousFlowRelativePermeabilityBW:

[legend]

Public Member Functions
	PorousFlowRelativePermeabilityBW (const InputParameters &parameters)

Protected Member Functions
virtual Real	relativePermeability (Real 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 Real	effectiveSaturation (Real saturation) const
	Effective saturation of fluid phase. More...

Protected Attributes
const Real	_sn
	BW's low saturation. More...

const Real	_ss
	BW's high saturation. More...

const Real	_kn
	BW's low relative permeability. More...

const Real	_ks
	BW's high relative permeability. More...

const Real	_c
	BW's C parameter. More...

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

const MaterialProperty< std::vector< Real > > &	_saturation
	Saturation material property. More...

MaterialProperty< Real > &	_relative_permeability
	Relative permeability material property. More...

MaterialProperty< Real > &	_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

Material that calculates the Broadbridge-White relative permeability P Broadbridge, I White `‘Constant rate rainfall infiltration: A versatile nonlinear model, 1 Analytical solution’'.

Water Resources Research 24 (1988) 145–154.

Definition at line 26 of file PorousFlowRelativePermeabilityBW.h.

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityBW()

PorousFlowRelativePermeabilityBW::PorousFlowRelativePermeabilityBW ( const InputParameters & parameters )

Definition at line 43 of file PorousFlowRelativePermeabilityBW.C.

   : PorousFlowRelativePermeabilityBase(parameters),
     _sn(getParam<Real>("Sn")),
     _ss(getParam<Real>("Ss")),
     _kn(getParam<Real>("Kn")),
     _ks(getParam<Real>("Ks")),
     _c(getParam<Real>("C"))
 {
   if (_ss <= _sn)
     mooseError("In BW relative permeability Sn set to ",
                _sn,
                " and Ss set to ",
                _ss,
                " but these must obey Ss > Sn");
   if (_ks <= _kn)
     mooseError("In BW relative permeability Kn set to ",
                _kn,
                " and Ks set to ",
                _ks,
                " but these must obey Ks > Kn");
 }

Member Function Documentation

◆ computeQpProperties()

void PorousFlowRelativePermeabilityBase::computeQpProperties ( )

overrideprotectedvirtualinherited

Definition at line 59 of file PorousFlowRelativePermeabilityBase.C.

 {
   // Effective saturation
   Real seff = effectiveSaturation(_saturation[_qp][_phase_num]);
   Real relperm, 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(seff);
   }
   else // seff > 1
   {
     // Relative permeability is 1 when fully saturated
     relperm = 1.0;
     drelperm = 0.0;
   }
  
   _relative_permeability[_qp] = relperm * _scaling;
   _drelative_permeability_ds[_qp] = drelperm * _dseff_ds * _scaling;
 }

◆ dRelativePermeability()

Real PorousFlowRelativePermeabilityBW::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 PorousFlowRelativePermeabilityBase.

Definition at line 73 of file PorousFlowRelativePermeabilityBW.C.

 {
   return PorousFlowBroadbridgeWhite::dRelativePermeability(seff, _c, _sn, _ss, _kn, _ks);
 }

◆ effectiveSaturation()

Real PorousFlowRelativePermeabilityBase::effectiveSaturation ( Real saturation ) const

protectedvirtualinherited

Effective saturation of fluid phase.

Parameters

saturation true saturation

Returns: effective saturation

Definition at line 88 of file PorousFlowRelativePermeabilityBase.C.

 {
   return (saturation - _s_res) / (1.0 - _sum_s_res);
 }

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ relativePermeability()

Real PorousFlowRelativePermeabilityBW::relativePermeability ( Real seff ) const

overrideprotectedvirtual

Relative permeability equation (must be overriden in derived class)

Parameters

seff	effective saturation

Returns: relative permeability

Implements PorousFlowRelativePermeabilityBase.

Definition at line 67 of file PorousFlowRelativePermeabilityBW.C.

 {
   return PorousFlowBroadbridgeWhite::relativePermeability(seff, _c, _sn, _ss, _kn, _ks);
 }

Member Data Documentation

◆ _c

const Real PorousFlowRelativePermeabilityBW::_c

protected

BW's C parameter.

Definition at line 48 of file PorousFlowRelativePermeabilityBW.h.

Referenced by dRelativePermeability(), and relativePermeability().

◆ _drelative_permeability_ds

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_drelative_permeability_ds

protectedinherited

Derivative of relative permeability wrt phase saturation.

Definition at line 63 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _dseff_ds

const Real PorousFlowRelativePermeabilityBase::_dseff_ds

protectedinherited

Derivative of effective saturation with respect to saturation.

Definition at line 72 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _kn

const Real PorousFlowRelativePermeabilityBW::_kn

protected

BW's low relative permeability.

Definition at line 42 of file PorousFlowRelativePermeabilityBW.h.

Referenced by dRelativePermeability(), PorousFlowRelativePermeabilityBW(), and relativePermeability().

◆ _ks

const Real PorousFlowRelativePermeabilityBW::_ks

protected

BW's high relative permeability.

Definition at line 45 of file PorousFlowRelativePermeabilityBW.h.

Referenced by dRelativePermeability(), PorousFlowRelativePermeabilityBW(), and relativePermeability().

◆ _phase

const std::string PorousFlowMaterialBase::_phase

protectedinherited

Stringified fluid phase number.

Definition at line 37 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num

protectedinherited

Phase number of fluid.

Definition at line 34 of file PorousFlowMaterialBase.h.

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

◆ _relative_permeability

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_relative_permeability

protectedinherited

Relative permeability material property.

Definition at line 60 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _s_res

const Real PorousFlowRelativePermeabilityBase::_s_res

protectedinherited

Residual saturation of specified phase.

Definition at line 66 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::effectiveSaturation(), and PorousFlowRelativePermeabilityBase::PorousFlowRelativePermeabilityBase().

◆ _saturation

const MaterialProperty<std::vector<Real> >& PorousFlowRelativePermeabilityBase::_saturation

protectedinherited

Saturation material property.

Definition at line 57 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _scaling

const Real PorousFlowRelativePermeabilityBase::_scaling

protectedinherited

Relative permeability is multiplied by this quantity.

Definition at line 54 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _sn

const Real PorousFlowRelativePermeabilityBW::_sn

protected

BW's low saturation.

Definition at line 36 of file PorousFlowRelativePermeabilityBW.h.

Referenced by dRelativePermeability(), PorousFlowRelativePermeabilityBW(), and relativePermeability().

◆ _ss

const Real PorousFlowRelativePermeabilityBW::_ss

protected

BW's high saturation.

Definition at line 39 of file PorousFlowRelativePermeabilityBW.h.

Referenced by dRelativePermeability(), PorousFlowRelativePermeabilityBW(), and relativePermeability().

◆ _sum_s_res

const Real PorousFlowRelativePermeabilityBase::_sum_s_res

protectedinherited

Sum of residual saturations over all phases.

Definition at line 69 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::effectiveSaturation(), and PorousFlowRelativePermeabilityBase::PorousFlowRelativePermeabilityBase().

The documentation for this class was generated from the following files:

porous_flow/include/materials/PorousFlowRelativePermeabilityBW.h
porous_flow/src/materials/PorousFlowRelativePermeabilityBW.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityBW()

Member Function Documentation

◆ computeQpProperties()

◆ dRelativePermeability()

◆ effectiveSaturation()

◆ relativePermeability()

Member Data Documentation

◆ _c

◆ _drelative_permeability_ds

◆ _dseff_ds

◆ _kn

◆ _ks

◆ _phase

◆ _phase_num

◆ _relative_permeability

◆ _s_res

◆ _saturation

◆ _scaling

◆ _sn

◆ _ss

◆ _sum_s_res