www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PorousFlowRelativePermeabilityBW Class Reference

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 27 of file PorousFlowRelativePermeabilityBW.h.

Constructor & Destructor Documentation

◆ PorousFlowRelativePermeabilityBW()

PorousFlowRelativePermeabilityBW::PorousFlowRelativePermeabilityBW ( const InputParameters &  parameters)

Definition at line 43 of file PorousFlowRelativePermeabilityBW.C.

46  _sn(getParam<Real>("Sn")),
47  _ss(getParam<Real>("Ss")),
48  _kn(getParam<Real>("Kn")),
49  _ks(getParam<Real>("Ks")),
50  _c(getParam<Real>("C"))
51 {
52  if (_ss <= _sn)
53  mooseError("In BW relative permeability Sn set to ",
54  _sn,
55  " and Ss set to ",
56  _ss,
57  " but these must obey Ss > Sn");
58  if (_ks <= _kn)
59  mooseError("In BW relative permeability Kn set to ",
60  _kn,
61  " and Ks set to ",
62  _ks,
63  " but these must obey Ks > Kn");
64 }
PorousFlowRelativePermeabilityBase(const InputParameters &parameters)
const Real _ks
BW&#39;s high relative permeability.
const Real _kn
BW&#39;s low relative permeability.
const Real _ss
BW&#39;s high saturation.
const Real _sn
BW&#39;s low saturation.

Member Function Documentation

◆ computeQpProperties()

void PorousFlowRelativePermeabilityBase::computeQpProperties ( )
overrideprotectedvirtualinherited

Definition at line 59 of file PorousFlowRelativePermeabilityBase.C.

60 {
61  // Effective saturation
62  Real seff = effectiveSaturation(_saturation[_qp][_phase_num]);
63  Real relperm, drelperm;
64 
65  if (seff < 0.0)
66  {
67  // Relative permeability is 0 for saturation less than residual
68  relperm = 0.0;
69  drelperm = 0.0;
70  }
71  else if (seff >= 0.0 && seff <= 1)
72  {
73  relperm = relativePermeability(seff);
74  drelperm = dRelativePermeability(seff);
75  }
76  else // seff > 1
77  {
78  // Relative permeability is 1 when fully saturated
79  relperm = 1.0;
80  drelperm = 0.0;
81  }
82 
83  _relative_permeability[_qp] = relperm * _scaling;
84  _drelative_permeability_ds[_qp] = drelperm * _dseff_ds * _scaling;
85 }
const Real _scaling
Relative permeability is multiplied by this quantity.
MaterialProperty< Real > & _relative_permeability
Relative permeability material property.
const Real _dseff_ds
Derivative of effective saturation with respect to saturation.
const MaterialProperty< std::vector< Real > > & _saturation
Saturation material property.
virtual Real effectiveSaturation(Real saturation) const
Effective saturation of fluid phase.
const unsigned int _phase_num
Phase number of fluid.
virtual Real relativePermeability(Real seff) const =0
Relative permeability equation (must be overriden in derived class)
virtual Real dRelativePermeability(Real seff) const =0
Derivative of relative permeability with respect to effective saturation.
MaterialProperty< Real > & _drelative_permeability_ds
Derivative of relative permeability wrt phase saturation.

◆ dRelativePermeability()

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

Definition at line 73 of file PorousFlowRelativePermeabilityBW.C.

74 {
76 }
const Real _ks
BW&#39;s high relative permeability.
const Real _kn
BW&#39;s low relative permeability.
Real dRelativePermeability(Real s, Real c, Real sn, Real ss, Real kn, Real ks)
Derivative of relative permeability with respect to saturation.
const Real _ss
BW&#39;s high saturation.
const Real _sn
BW&#39;s low saturation.

◆ effectiveSaturation()

Real PorousFlowRelativePermeabilityBase::effectiveSaturation ( Real  saturation) const
protectedvirtualinherited

Effective saturation of fluid phase.

Parameters
saturationtrue saturation
Returns
effective saturation

Definition at line 88 of file PorousFlowRelativePermeabilityBase.C.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

89 {
90  return (saturation - _s_res) / (1.0 - _sum_s_res);
91 }
const Real _sum_s_res
Sum of residual saturations over all phases.
const Real _s_res
Residual saturation of specified phase.

◆ relativePermeability()

Real PorousFlowRelativePermeabilityBW::relativePermeability ( Real  seff) const
overrideprotectedvirtual

Relative permeability equation (must be overriden in derived class)

Parameters
seffeffective saturation
Returns
relative permeability

Implements PorousFlowRelativePermeabilityBase.

Definition at line 67 of file PorousFlowRelativePermeabilityBW.C.

68 {
70 }
const Real _ks
BW&#39;s high relative permeability.
const Real _kn
BW&#39;s low relative permeability.
Real relativePermeability(Real s, Real c, Real sn, Real ss, Real kn, Real ks)
Relative permeability as a function of saturation.
const Real _ss
BW&#39;s high saturation.
const Real _sn
BW&#39;s low saturation.

Member Data Documentation

◆ _c

const Real PorousFlowRelativePermeabilityBW::_c
protected

BW's C parameter.

Definition at line 49 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 64 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 73 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _kn

const Real PorousFlowRelativePermeabilityBW::_kn
protected

BW's low relative permeability.

Definition at line 43 of file PorousFlowRelativePermeabilityBW.h.

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

◆ _ks

const Real PorousFlowRelativePermeabilityBW::_ks
protected

BW's high relative permeability.

Definition at line 46 of file PorousFlowRelativePermeabilityBW.h.

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

◆ _phase

const std::string PorousFlowMaterialBase::_phase
protectedinherited

Stringified fluid phase number.

Definition at line 38 of file PorousFlowMaterialBase.h.

◆ _phase_num

const unsigned int PorousFlowMaterialBase::_phase_num
protectedinherited

◆ _relative_permeability

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_relative_permeability
protectedinherited

Relative permeability material property.

Definition at line 61 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _s_res

const Real PorousFlowRelativePermeabilityBase::_s_res
protectedinherited

◆ _saturation

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

Saturation material property.

Definition at line 58 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _scaling

const Real PorousFlowRelativePermeabilityBase::_scaling
protectedinherited

Relative permeability is multiplied by this quantity.

Definition at line 55 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

◆ _sn

const Real PorousFlowRelativePermeabilityBW::_sn
protected

◆ _ss

const Real PorousFlowRelativePermeabilityBW::_ss
protected

BW's high saturation.

Definition at line 40 of file PorousFlowRelativePermeabilityBW.h.

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

◆ _sum_s_res

const Real PorousFlowRelativePermeabilityBase::_sum_s_res
protectedinherited

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