RichardsSeff Class Reference

Base class for effective saturation as a function of porepressure(s) The functions seff, dseff and d2seff must be over-ridden in the derived class. More...

#include <RichardsSeff.h>

Inheritance diagram for RichardsSeff:

Public Member Functions
	RichardsSeff (const InputParameters &parameters)
void	initialize ()
void	execute ()
void	finalize ()
virtual Real	seff (std::vector< const VariableValue * > p, unsigned int qp) const =0
	effective saturation as a function of porepressure(s) at given quadpoint of the element More...
virtual void	dseff (std::vector< const VariableValue * > p, unsigned int qp, std::vector< Real > &result) const =0
	derivative(s) of effective saturation as a function of porepressure(s) at given quadpoint of the element If there are three porepressures, this will return at length-3 vector (dSeff/dP[0], dSeff/dP[1], dSeff/dP[2]) More...
virtual void	d2seff (std::vector< const VariableValue * > p, unsigned int qp, std::vector< std::vector< Real >> &result) const =0
	second derivative(s) of effective saturation as a function of porepressure(s) at given quadpoint of the element d2seff[m][n] = d^2 Seff/dP[m]/dP[n] More...

Detailed Description

Base class for effective saturation as a function of porepressure(s) The functions seff, dseff and d2seff must be over-ridden in the derived class.

Definition at line 23 of file RichardsSeff.h.

Constructor & Destructor Documentation

RichardsSeff()

RichardsSeff::RichardsSeff

(

const InputParameters &

parameters

)

Definition at line 24 of file RichardsSeff.C.

: GeneralUserObject(parameters) {}

Member Function Documentation

d2seff()

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

pure virtual

second derivative(s) of effective saturation as a function of porepressure(s) at given quadpoint of the element d2seff[m][n] = d^2 Seff/dP[m]/dP[n]

Parameters

p	the porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qp	the quad point of the element to evaluate the derivative at
result	the derivtives will be placed in this array

Implemented in RichardsSeff1VGcut, RichardsSeff1BWsmall, RichardsSeff2gasRSC, RichardsSeff2waterRSC, RichardsSeff1RSC, RichardsSeff2gasVGshifted, RichardsSeff2waterVGshifted, RichardsSeff1VG, RichardsSeff2gasVG, and RichardsSeff2waterVG.

Referenced by RichardsSeffPrimePrimeAux::computeValue().

dseff()

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

pure virtual

derivative(s) of effective saturation as a function of porepressure(s) at given quadpoint of the element If there are three porepressures, this will return at length-3 vector (dSeff/dP[0], dSeff/dP[1], dSeff/dP[2])

Parameters

p	the porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qp	the quad point of the element to evaluate the derivative at
result	the derivtives will be placed in this array

Implemented in RichardsSeff1VGcut, RichardsSeff1BWsmall, RichardsSeff2gasRSC, RichardsSeff2waterRSC, RichardsSeff1RSC, RichardsSeff2gasVGshifted, RichardsSeff2waterVGshifted, RichardsSeff1VG, RichardsSeff2gasVG, and RichardsSeff2waterVG.

Referenced by RichardsSeffPrimeAux::computeValue(), RichardsFullyUpwindFlux::prepareNodalValues(), RichardsBorehole::prepareNodalValues(), and RichardsPiecewiseLinearSink::prepareNodalValues().

execute()

void RichardsSeff::execute

(

)

Definition at line 32 of file RichardsSeff.C.

{
}

finalize()

void RichardsSeff::finalize

(

)

Definition at line 37 of file RichardsSeff.C.

{
}

initialize()

void RichardsSeff::initialize

(

)

Definition at line 27 of file RichardsSeff.C.

{
}

seff()

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

pure virtual

effective saturation as a function of porepressure(s) at given quadpoint of the element

Parameters

p	the porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qp	the quad point of the element to evaluate effective saturation at.

Implemented in RichardsSeff1VGcut, RichardsSeff1BWsmall, RichardsSeff2gasRSC, RichardsSeff2waterRSC, RichardsSeff1RSC, RichardsSeff2gasVGshifted, RichardsSeff2waterVGshifted, RichardsSeff1VG, RichardsSeff2gasVG, and RichardsSeff2waterVG.

Referenced by RichardsSeffAux::computeValue(), RichardsFullyUpwindFlux::prepareNodalValues(), RichardsBorehole::prepareNodalValues(), and RichardsPiecewiseLinearSink::prepareNodalValues().

---

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

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