RichardsSeff2waterVGshifted Class Reference

Shifted van-Genuchten water effective saturation as a function of (Pwater, Pgas), and its derivs wrt to those pressures. More...

#include <RichardsSeff2waterVGshifted.h>

Inheritance diagram for RichardsSeff2waterVGshifted:

Public Member Functions
	RichardsSeff2waterVGshifted (const InputParameters &parameters)
Real	seff (std::vector< const VariableValue * > p, unsigned int qp) const
	water effective saturation More...
void	dseff (std::vector< const VariableValue * > p, unsigned int qp, std::vector< Real > &result) const
	derivative of effective saturation as a function of porepressure More...
void	d2seff (std::vector< const VariableValue * > p, unsigned int qp, std::vector< std::vector< Real >> &result) const
	second derivative of effective saturation as a function of porepressure More...
void	initialize ()
void	execute ()
void	finalize ()

Protected Attributes
Real	_al
	van Genuchten alpha parameter More...
Real	_m
	van Genuchten m parameter More...
Real	_shift
	shift More...
Real	_scale
	scale More...

Detailed Description

Shifted van-Genuchten water effective saturation as a function of (Pwater, Pgas), and its derivs wrt to those pressures.

Note that the water pressure appears first in the tuple (Pwater, Pgas) This takes the original van-Genuchten Seff = Seff(Pwater-Pgas), and shifts it to the right by "shift", and scales the result so 0<=Seff<=1. The purpose of this is so dSeff/dP>0 at P=0.

Definition at line 28 of file RichardsSeff2waterVGshifted.h.

Constructor & Destructor Documentation

RichardsSeff2waterVGshifted()

RichardsSeff2waterVGshifted::RichardsSeff2waterVGshifted

(

const InputParameters &

parameters

)

Definition at line 47 of file RichardsSeff2waterVGshifted.C.

  : RichardsSeff(parameters),
    _al(getParam<Real>("al")),
    _m(getParam<Real>("m")),
    _shift(getParam<Real>("shift"))
{
  _scale = RichardsSeffVG::seff(-_shift, _al, _m);
}

Member Function Documentation

d2seff()

void RichardsSeff2waterVGshifted::d2seff ( std::vector< const VariableValue * >  p, unsigned int  qp, std::vector< std::vector< Real >> &  result  ) const

virtual

second derivative of effective saturation as a function of porepressure

Parameters

p	porepressure in the element. Note that (*p[0])[qp] is the porepressure at quadpoint qp
qp	the quad point to evaluate effective saturation at
result	the derivtives will be placed in this array

Implements RichardsSeff.

Definition at line 76 of file RichardsSeff2waterVGshifted.C.

{
  Real negpc = (*p[0])[qp] - (*p[1])[qp];
  negpc = negpc - _shift;
  result[0][0] = RichardsSeffVG::d2seff(negpc, _al, _m) / _scale;
  result[0][1] = -result[0][0];
  result[1][0] = -result[0][0];
  result[1][1] = result[0][0];
}

dseff()

void RichardsSeff2waterVGshifted::dseff ( std::vector< const VariableValue * >  p, unsigned int  qp, std::vector< Real > &  result  ) const

virtual

derivative of effective saturation as a function of porepressure

Parameters

p	porepressure in the element. Note that (*p[0])[qp] is the porepressure at quadpoint qp
qp	the quad point to evaluate effective saturation at
result	the derivtives will be placed in this array

Implements RichardsSeff.

Definition at line 65 of file RichardsSeff2waterVGshifted.C.

{
  Real negpc = (*p[0])[qp] - (*p[1])[qp];
  negpc = negpc - _shift;
  result[0] = RichardsSeffVG::dseff(negpc, _al, _m) / _scale;
  result[1] = -result[0];
}

execute()

void RichardsSeff::execute ( )

inherited

Definition at line 32 of file RichardsSeff.C.

{
}

finalize()

void RichardsSeff::finalize ( )

inherited

Definition at line 37 of file RichardsSeff.C.

{
}

initialize()

void RichardsSeff::initialize ( )

inherited

Definition at line 27 of file RichardsSeff.C.

{
}

seff()

Real RichardsSeff2waterVGshifted::seff ( std::vector< const VariableValue * >  p, unsigned int  qp  ) const

virtual

water effective saturation

Parameters

p	porepressures. Here (*p[0])[qp] is the water pressure at quadpoint qp, and (*p[1])[qp] is the gas porepressure
qp	the quadpoint to evaluate effective saturation at

Implements RichardsSeff.

Definition at line 57 of file RichardsSeff2waterVGshifted.C.

{
  Real negpc = (*p[0])[qp] - (*p[1])[qp];
  negpc = negpc - _shift;
  return std::min(RichardsSeffVG::seff(negpc, _al, _m) / _scale, 1.0);
}

Member Data Documentation

_al

Real RichardsSeff2waterVGshifted::_al

protected

van Genuchten alpha parameter

Definition at line 64 of file RichardsSeff2waterVGshifted.h.

Referenced by d2seff(), dseff(), RichardsSeff2waterVGshifted(), and seff().

_m

Real RichardsSeff2waterVGshifted::_m

protected

van Genuchten m parameter

Definition at line 67 of file RichardsSeff2waterVGshifted.h.

Referenced by d2seff(), dseff(), RichardsSeff2waterVGshifted(), and seff().

_scale

Real RichardsSeff2waterVGshifted::_scale

protected

scale

Definition at line 73 of file RichardsSeff2waterVGshifted.h.

Referenced by d2seff(), dseff(), RichardsSeff2waterVGshifted(), and seff().

_shift

Real RichardsSeff2waterVGshifted::_shift

protected

shift

Definition at line 70 of file RichardsSeff2waterVGshifted.h.

Referenced by d2seff(), dseff(), RichardsSeff2waterVGshifted(), and seff().

---

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

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