RichardsRelPermPower Class Reference

Power form of relative permeability, usually used for water. More...

#include <RichardsRelPermPower.h>

Inheritance diagram for RichardsRelPermPower:

Public Member Functions
	RichardsRelPermPower (const InputParameters &parameters)
Real	relperm (Real seff) const
	relative permeability as a function of effective saturation More...
Real	drelperm (Real seff) const
	derivative of relative permeability wrt effective saturation More...
Real	d2relperm (Real seff) const
	second derivative of relative permeability wrt effective saturation More...
void	initialize ()
void	execute ()
void	finalize ()

Protected Attributes
Real	_simm
	immobile saturation More...
Real	_n
	exponent used in the power relationship More...

Detailed Description

Power form of relative permeability, usually used for water.

Definition at line 23 of file RichardsRelPermPower.h.

Constructor & Destructor Documentation

RichardsRelPermPower()

RichardsRelPermPower::RichardsRelPermPower

(

const InputParameters &

parameters

)

Definition at line 38 of file RichardsRelPermPower.C.

  : RichardsRelPerm(parameters), _simm(getParam<Real>("simm")), _n(getParam<Real>("n"))
{
}

Member Function Documentation

d2relperm()

Real RichardsRelPermPower::d2relperm ( Real  seff ) const

virtual

second derivative of relative permeability wrt effective saturation

Parameters

seff	effective sasturation

Implements RichardsRelPerm.

Definition at line 83 of file RichardsRelPermPower.C.

{
  if (seff >= 1.0)
    return 0.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
  Real krelpp = (_n + 1) * _n * (_n - 1) * std::pow(s_internal, _n - 2) -
                _n * (_n + 1) * _n * std::pow(s_internal, _n - 1);
  return krelpp / std::pow(1.0 - _simm, 2);
}

drelperm()

Real RichardsRelPermPower::drelperm ( Real  seff ) const

virtual

derivative of relative permeability wrt effective saturation

Parameters

seff	effective sasturation

Implements RichardsRelPerm.

Definition at line 68 of file RichardsRelPermPower.C.

{
  if (seff >= 1.0)
    return 0.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
  Real krelp =
      (_n + 1) * _n * std::pow(s_internal, _n - 1) - _n * (_n + 1) * std::pow(s_internal, _n);
  return krelp / (1.0 - _simm);
}

execute()

void RichardsRelPerm::execute ( )

inherited

Definition at line 34 of file RichardsRelPerm.C.

{
}

finalize()

void RichardsRelPerm::finalize ( )

inherited

Definition at line 39 of file RichardsRelPerm.C.

{
}

initialize()

void RichardsRelPerm::initialize ( )

inherited

Definition at line 29 of file RichardsRelPerm.C.

{
}

relperm()

Real RichardsRelPermPower::relperm ( Real  seff ) const

virtual

relative permeability as a function of effective saturation

Parameters

seff	effective sasturation

Implements RichardsRelPerm.

Definition at line 44 of file RichardsRelPermPower.C.

{
  if (seff >= 1.0)
    return 1.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
  Real krel = (_n + 1) * std::pow(s_internal, _n) - _n * std::pow(s_internal, _n + 1);
 
  // bound, just in case
  if (krel < 0)
  {
    krel = 0;
  }
  if (krel > 1)
  {
    krel = 1;
  }
  return krel;
}

Member Data Documentation

_n

Real RichardsRelPermPower::_n

protected

exponent used in the power relationship

Definition at line 51 of file RichardsRelPermPower.h.

Referenced by d2relperm(), drelperm(), and relperm().

_simm

Real RichardsRelPermPower::_simm

protected

immobile saturation

Definition at line 48 of file RichardsRelPermPower.h.

Referenced by d2relperm(), drelperm(), and relperm().

---

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

• richards/include/userobjects/RichardsRelPermPower.h
• richards/src/userobjects/RichardsRelPermPower.C