www.mooseframework.org
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RichardsSatAux Class Reference

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

#include <RichardsSatAux.h>

Inheritance diagram for RichardsSatAux:
[legend]

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 24 of file RichardsSatAux.h.

Constructor & Destructor Documentation

RichardsSatAux::RichardsSatAux ( const InputParameters &  parameters)

Definition at line 23 of file RichardsSatAux.C.

24  : AuxKernel(parameters),
25  _seff_var(coupledValue("seff_var")),
26  _sat_UO(getUserObject<RichardsSat>("sat_UO"))
27 {
28 }
const VariableValue & _seff_var
effective saturation
const RichardsSat & _sat_UO
User object defining saturation as a function of effective saturation.

Member Function Documentation

Real RichardsSatAux::computeValue ( )
protectedvirtual

Definition at line 31 of file RichardsSatAux.C.

32 {
33  return _sat_UO.sat(_seff_var[_qp]);
34 }
const VariableValue & _seff_var
effective saturation
const RichardsSat & _sat_UO
User object defining saturation as a function of effective saturation.
Real sat(Real seff) const
saturation as a function of effective saturation
Definition: RichardsSat.C:56

Member Data Documentation

const RichardsSat& RichardsSatAux::_sat_UO
protected

User object defining saturation as a function of effective saturation.

Definition at line 36 of file RichardsSatAux.h.

Referenced by computeValue().

const VariableValue& RichardsSatAux::_seff_var
protected

effective saturation

Definition at line 33 of file RichardsSatAux.h.

Referenced by computeValue().


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