RichardsRelPermMonomial Class Reference

Monomial form of relative permeability relperm = Seff^n for 0<Seff<=1, where S = (S - simm)/(1 - simm) relperm = 1 for Seff>1 relperm = 0 for Seff<0, except if n=0 then relperm = zero_to_the_zero. More...

#include <RichardsRelPermMonomial.h>

Inheritance diagram for RichardsRelPermMonomial:

Public Member Functions
	RichardsRelPermMonomial (const InputParameters &parameters)
Real	relperm (Real seff) const
	Relative permeability. More...
Real	drelperm (Real seff) const
	Derivative of elative permeability wrt seff. More...
Real	d2relperm (Real seff) const
	Second derivative of elative permeability wrt seff. More...
void	initialize ()
void	execute ()
void	finalize ()

Protected Attributes
Real	_simm
	immobile saturation More...
Real	_n
	exponent, must be >= 0 More...
Real	_zero_to_the_zero
	0^0, which is used if _n=0 More...

Detailed Description

Monomial form of relative permeability relperm = Seff^n for 0<Seff<=1, where S = (S - simm)/(1 - simm) relperm = 1 for Seff>1 relperm = 0 for Seff<0, except if n=0 then relperm = zero_to_the_zero.

Definition at line 25 of file RichardsRelPermMonomial.h.

Constructor & Destructor Documentation

RichardsRelPermMonomial()

RichardsRelPermMonomial::RichardsRelPermMonomial

(

const InputParameters &

parameters

)

Definition at line 37 of file RichardsRelPermMonomial.C.

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

Member Function Documentation

d2relperm()

Real RichardsRelPermMonomial::d2relperm ( Real  seff ) const

virtual

Second derivative of elative permeability wrt seff.

Parameters

seff	effective saturation

Implements RichardsRelPerm.

Definition at line 90 of file RichardsRelPermMonomial.C.

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

drelperm()

Real RichardsRelPermMonomial::drelperm ( Real  seff ) const

virtual

Derivative of elative permeability wrt seff.

Parameters

seff	effective saturation

Implements RichardsRelPerm.

Definition at line 73 of file RichardsRelPermMonomial.C.

{
  if (seff >= 1.0)
    return 0.0;
 
  if (seff <= _simm)
    return 0.0;
 
  if (_n == 0)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
  Real krelp = _n * std::pow(s_internal, _n - 1);
  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 RichardsRelPermMonomial::relperm ( Real  seff ) const

virtual

Relative permeability.

Parameters

seff	effective saturation

Implements RichardsRelPerm.

Definition at line 46 of file RichardsRelPermMonomial.C.

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

Member Data Documentation

_n

Real RichardsRelPermMonomial::_n

protected

exponent, must be >= 0

Definition at line 53 of file RichardsRelPermMonomial.h.

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

_simm

Real RichardsRelPermMonomial::_simm

protected

immobile saturation

Definition at line 50 of file RichardsRelPermMonomial.h.

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

_zero_to_the_zero

Real RichardsRelPermMonomial::_zero_to_the_zero

protected

0^0, which is used if _n=0

Definition at line 56 of file RichardsRelPermMonomial.h.

Referenced by relperm().

---

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

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