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

Constructor & Destructor Documentation

◆ RichardsSatAux()

RichardsSatAux::RichardsSatAux ( const InputParameters &  parameters)

Definition at line 27 of file RichardsSatAux.C.

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

Member Function Documentation

◆ computeValue()

Real RichardsSatAux::computeValue ( )
protectedvirtual

Definition at line 35 of file RichardsSatAux.C.

36 {
37  return _sat_UO.sat(_seff_var[_qp]);
38 }
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:60

Member Data Documentation

◆ _sat_UO

const RichardsSat& RichardsSatAux::_sat_UO
protected

User object defining saturation as a function of effective saturation.

Definition at line 38 of file RichardsSatAux.h.

Referenced by computeValue().

◆ _seff_var

const VariableValue& RichardsSatAux::_seff_var
protected

effective saturation

Definition at line 35 of file RichardsSatAux.h.

Referenced by computeValue().


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