RichardsRelPerm Class Reference

Base class for Richards relative permeability classes that provide relative permeability as a function of effective saturation. More...

#include <RichardsRelPerm.h>

Inheritance diagram for RichardsRelPerm:

Public Member Functions
	RichardsRelPerm (const InputParameters &parameters)
void	initialize ()
void	execute ()
void	finalize ()
virtual Real	relperm (Real seff) const =0
	relative permeability as a function of effective saturation This must be over-ridden in your derived class to provide actual values of relative permeability More...
virtual Real	drelperm (Real seff) const =0
	derivative of relative permeability wrt effective saturation This must be over-ridden in your derived class to provide actual values of derivative of relative permeability More...
virtual Real	d2relperm (Real seff) const =0
	second derivative of relative permeability wrt effective saturation This must be over-ridden in your derived class to provide actual values of second derivative of relative permeability More...

Detailed Description

Base class for Richards relative permeability classes that provide relative permeability as a function of effective saturation.

Definition at line 23 of file RichardsRelPerm.h.

Constructor & Destructor Documentation

RichardsRelPerm()

RichardsRelPerm::RichardsRelPerm

(

const InputParameters &

parameters

)

Definition at line 24 of file RichardsRelPerm.C.

                                                                   : GeneralUserObject(parameters)
{
}

Member Function Documentation

d2relperm()

virtual Real RichardsRelPerm::d2relperm ( Real  seff ) const

pure virtual

second derivative of relative permeability wrt effective saturation This must be over-ridden in your derived class to provide actual values of second derivative of relative permeability

Parameters

seff	effective saturation

Implemented in RichardsRelPermVG1, Q2PRelPermPowerGas, RichardsRelPermMonomial, RichardsRelPermBW, RichardsRelPermPowerGas, RichardsRelPermPower, and RichardsRelPermVG.

Referenced by RichardsRelPermPrimePrimeAux::computeValue().

drelperm()

virtual Real RichardsRelPerm::drelperm ( Real  seff ) const

pure virtual

derivative of relative permeability wrt effective saturation This must be over-ridden in your derived class to provide actual values of derivative of relative permeability

Parameters

seff	effective saturation

Implemented in RichardsRelPermVG1, Q2PRelPermPowerGas, RichardsRelPermMonomial, RichardsRelPermBW, RichardsRelPermPowerGas, RichardsRelPermPower, and RichardsRelPermVG.

Referenced by Q2PSaturationDiffusion::computeQpJacobian(), RichardsRelPermPrimeAux::computeValue(), RichardsFullyUpwindFlux::prepareNodalValues(), Q2PSaturationFlux::prepareNodalValues(), Q2PPorepressureFlux::prepareNodalValues(), Q2PPiecewiseLinearSink::prepareNodalValues(), Q2PBorehole::prepareNodalValues(), RichardsBorehole::prepareNodalValues(), and RichardsPiecewiseLinearSink::prepareNodalValues().

execute()

void RichardsRelPerm::execute

(

)

Definition at line 34 of file RichardsRelPerm.C.

{
}

finalize()

void RichardsRelPerm::finalize

(

)

Definition at line 39 of file RichardsRelPerm.C.

{
}

initialize()

void RichardsRelPerm::initialize

(

)

Definition at line 29 of file RichardsRelPerm.C.

{
}

relperm()

virtual Real RichardsRelPerm::relperm ( Real  seff ) const

pure virtual

relative permeability as a function of effective saturation This must be over-ridden in your derived class to provide actual values of relative permeability

Parameters

seff	effective saturation

Implemented in RichardsRelPermVG1, Q2PRelPermPowerGas, RichardsRelPermMonomial, RichardsRelPermBW, RichardsRelPermPowerGas, RichardsRelPermPower, and RichardsRelPermVG.

Referenced by Q2PPiecewiseLinearSinkFlux::computeQpIntegral(), Q2PSaturationDiffusion::computeQpJacobian(), Q2PSaturationDiffusion::computeQpOffDiagJacobian(), Q2PSaturationDiffusion::computeQpResidual(), RichardsRelPermAux::computeValue(), RichardsFullyUpwindFlux::prepareNodalValues(), Q2PSaturationFlux::prepareNodalValues(), Q2PPorepressureFlux::prepareNodalValues(), Q2PPiecewiseLinearSink::prepareNodalValues(), Q2PBorehole::prepareNodalValues(), RichardsBorehole::prepareNodalValues(), and RichardsPiecewiseLinearSink::prepareNodalValues().

---

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

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