RichardsRelPermVG1 Class Reference

Van-Genuchten form of relative permeability when seff <= _scut cubic relative permeability for seff >= _scut These two match in value and derivative at seff = _scut and relperm = 1 for seff = 1. More...

#include <RichardsRelPermVG1.h>

Inheritance diagram for RichardsRelPermVG1:

Public Member Functions
	RichardsRelPermVG1 (const InputParameters &parameters)
void	initialSetup ()
	just prints some (maybe) useful info to the console More...
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	_m
	van Genuchten m parameter More...
Real	_scut
	for seff > _scut use cubic relative permeability, otherwise use van Genuchten More...
Real	_vg1_const
	constant in cubic relperm relation More...
Real	_vg1_linear
	coefficient of linear term in cubic relperm relation More...
Real	_vg1_quad
	coefficient of quadratic term in cubic relperm relation More...
Real	_vg1_cub
	coefficient of cubic term in cubic relperm relation More...

Detailed Description

Van-Genuchten form of relative permeability when seff <= _scut cubic relative permeability for seff >= _scut These two match in value and derivative at seff = _scut and relperm = 1 for seff = 1.

Definition at line 25 of file RichardsRelPermVG1.h.

Constructor & Destructor Documentation

RichardsRelPermVG1()

RichardsRelPermVG1::RichardsRelPermVG1

(

const InputParameters &

parameters

)

Definition at line 41 of file RichardsRelPermVG1.C.

  : RichardsRelPermVG(parameters),
    _simm(getParam<Real>("simm")),
    _m(getParam<Real>("m")),
    _scut(getParam<Real>("scut")),
    _vg1_const(0),
    _vg1_linear(0),
    _vg1_quad(0),
    _vg1_cub(0)
{
  _vg1_const = RichardsRelPermVG::relperm(_scut);
  _vg1_linear = RichardsRelPermVG::drelperm(_scut);
  _vg1_quad = RichardsRelPermVG::d2relperm(_scut);
  _vg1_cub = (1 - _vg1_const - _vg1_linear * (1 - _scut) - _vg1_quad * std::pow(1 - _scut, 2)) /
             std::pow(1 - _scut, 3);
}

Member Function Documentation

d2relperm()

Real RichardsRelPermVG1::d2relperm ( Real  seff ) const

virtual

second derivative of relative permeability wrt effective saturation

Parameters

seff	effective saturation

Reimplemented from RichardsRelPermVG.

Definition at line 115 of file RichardsRelPermVG1.C.

{
  if (seff >= 1.0)
    return 0.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
 
  if (s_internal < _scut)
    return RichardsRelPermVG::d2relperm(seff);
 
  Real krelpp = 2 * _vg1_quad + 6 * _vg1_cub * (s_internal - _scut);
  return krelpp / std::pow(1.0 - _simm, 2);
}

drelperm()

Real RichardsRelPermVG1::drelperm ( Real  seff ) const

virtual

derivative of relative permeability wrt effective saturation

Parameters

seff	effective saturation

Reimplemented from RichardsRelPermVG.

Definition at line 96 of file RichardsRelPermVG1.C.

{
  if (seff >= 1.0)
    return 0.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
 
  if (s_internal < _scut)
    return RichardsRelPermVG::drelperm(seff);
 
  Real krelp = _vg1_linear + 2 * _vg1_quad * (s_internal - _scut) +
               3 * _vg1_cub * std::pow(s_internal - _scut, 2);
  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.

{
}

initialSetup()

void RichardsRelPermVG1::initialSetup

(

)

just prints some (maybe) useful info to the console

Definition at line 59 of file RichardsRelPermVG1.C.

{
  _console << "Relative permeability of VG1 type has cubic coefficients " << _vg1_const << " "
           << _vg1_linear << " " << _vg1_quad << " " << _vg1_cub << std::endl;
}

relperm()

Real RichardsRelPermVG1::relperm ( Real  seff ) const

virtual

relative permeability as a function of effective saturation

Parameters

seff	effective saturation

Reimplemented from RichardsRelPermVG.

Definition at line 66 of file RichardsRelPermVG1.C.

{
  if (seff >= 1.0)
    return 1.0;
 
  if (seff <= _simm)
    return 0.0;
 
  Real s_internal = (seff - _simm) / (1.0 - _simm);
 
  if (s_internal < _scut)
    return RichardsRelPermVG::relperm(seff);
 
  Real krel = _vg1_const + _vg1_linear * (s_internal - _scut) +
              _vg1_quad * std::pow(s_internal - _scut, 2) +
              _vg1_cub * std::pow(s_internal - _scut, 3);
 
  // bound, just in case
  if (krel < 0)
  {
    krel = 0;
  }
  if (krel > 1)
  {
    krel = 1;
  }
  return krel;
}

Member Data Documentation

_m

Real RichardsRelPermVG1::_m

protected

van Genuchten m parameter

Definition at line 56 of file RichardsRelPermVG1.h.

_scut

Real RichardsRelPermVG1::_scut

protected

for seff > _scut use cubic relative permeability, otherwise use van Genuchten

Definition at line 59 of file RichardsRelPermVG1.h.

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

_simm

Real RichardsRelPermVG1::_simm

protected

immobile saturation

Definition at line 53 of file RichardsRelPermVG1.h.

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

_vg1_const

Real RichardsRelPermVG1::_vg1_const

protected

constant in cubic relperm relation

Definition at line 62 of file RichardsRelPermVG1.h.

Referenced by initialSetup(), relperm(), and RichardsRelPermVG1().

_vg1_cub

Real RichardsRelPermVG1::_vg1_cub

protected

coefficient of cubic term in cubic relperm relation

Definition at line 71 of file RichardsRelPermVG1.h.

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

_vg1_linear

Real RichardsRelPermVG1::_vg1_linear

protected

coefficient of linear term in cubic relperm relation

Definition at line 65 of file RichardsRelPermVG1.h.

Referenced by drelperm(), initialSetup(), relperm(), and RichardsRelPermVG1().

_vg1_quad

Real RichardsRelPermVG1::_vg1_quad

protected

coefficient of quadratic term in cubic relperm relation

Definition at line 68 of file RichardsRelPermVG1.h.

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

---

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

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