www.mooseframework.org
Public Member Functions | List of all members
RichardsSeff Class Referenceabstract

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:
[legend]

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 22 of file RichardsSeff.h.

Constructor & Destructor Documentation

RichardsSeff::RichardsSeff ( const InputParameters &  parameters)

Definition at line 22 of file RichardsSeff.C.

22 : GeneralUserObject(parameters) {}

Member Function Documentation

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
pthe porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qpthe quad point of the element to evaluate the derivative at
resultthe derivtives will be placed in this array

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

Referenced by RichardsSeffPrimePrimeAux::computeValue().

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
pthe porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qpthe quad point of the element to evaluate the derivative at
resultthe 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().

void RichardsSeff::execute ( )

Definition at line 30 of file RichardsSeff.C.

31 {
32 }
void RichardsSeff::finalize ( )

Definition at line 35 of file RichardsSeff.C.

36 {
37 }
void RichardsSeff::initialize ( )

Definition at line 25 of file RichardsSeff.C.

26 {
27 }
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
pthe porepressure(s). Eg (*p[0])[qp] is the zeroth pressure evaluated at quadpoint qp
qpthe 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: