RichardsSatAux Class Reference

Fluid Saturation as a function of effective saturation. More...

#include <RichardsSatAux.h>

Inheritance diagram for RichardsSatAux:

Public Member Functions
	RichardsSatAux (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const VariableValue &	_seff_var
	effective saturation More...
const RichardsSat &	_sat_UO
	User object defining saturation as a function of effective saturation. More...

Detailed Description

Fluid Saturation as a function of effective saturation.

Definition at line 25 of file RichardsSatAux.h.

Constructor & Destructor Documentation

RichardsSatAux()

RichardsSatAux::RichardsSatAux

(

const InputParameters &

parameters

)

Definition at line 27 of file RichardsSatAux.C.

  : AuxKernel(parameters),
    _seff_var(coupledValue("seff_var")),
    _sat_UO(getUserObject<RichardsSat>("sat_UO"))
{
}

Member Function Documentation

computeValue()

Real RichardsSatAux::computeValue ( )

protectedvirtual

Definition at line 35 of file RichardsSatAux.C.

{
  return _sat_UO.sat(_seff_var[_qp]);
}

Member Data Documentation

_sat_UO

const RichardsSat& RichardsSatAux::_sat_UO

protected

User object defining saturation as a function of effective saturation.

Definition at line 37 of file RichardsSatAux.h.

Referenced by computeValue().

_seff_var

const VariableValue& RichardsSatAux::_seff_var

protected

effective saturation

Definition at line 34 of file RichardsSatAux.h.

Referenced by computeValue().

---

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

• richards/include/auxkernels/RichardsSatAux.h
• richards/src/auxkernels/RichardsSatAux.C