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

Relative Permeability as a function of effective saturation. More...

#include <RichardsRelPermAux.h>

Inheritance diagram for RichardsRelPermAux:
[legend]

Public Member Functions

 RichardsRelPermAux (const InputParameters &parameters)
 

Protected Member Functions

virtual Real computeValue ()
 

Protected Attributes

const VariableValue & _seff_var
 effective saturation More...
 
const RichardsRelPerm_relperm_UO
 userobject that defines relative permeability function More...
 

Detailed Description

Relative Permeability as a function of effective saturation.

Definition at line 25 of file RichardsRelPermAux.h.

Constructor & Destructor Documentation

◆ RichardsRelPermAux()

RichardsRelPermAux::RichardsRelPermAux ( const InputParameters &  parameters)

Definition at line 28 of file RichardsRelPermAux.C.

29  : AuxKernel(parameters),
30  _seff_var(coupledValue("seff_var")),
31  _relperm_UO(getUserObject<RichardsRelPerm>("relperm_UO"))
32 {
33 }

Member Function Documentation

◆ computeValue()

Real RichardsRelPermAux::computeValue ( )
protectedvirtual

Definition at line 36 of file RichardsRelPermAux.C.

37 {
38  return _relperm_UO.relperm(_seff_var[_qp]);
39 }

Member Data Documentation

◆ _relperm_UO

const RichardsRelPerm& RichardsRelPermAux::_relperm_UO
protected

userobject that defines relative permeability function

Definition at line 37 of file RichardsRelPermAux.h.

Referenced by computeValue().

◆ _seff_var

const VariableValue& RichardsRelPermAux::_seff_var
protected

effective saturation

Definition at line 34 of file RichardsRelPermAux.h.

Referenced by computeValue().


The documentation for this class was generated from the following files:
RichardsRelPerm::relperm
virtual Real relperm(Real seff) const =0
relative permeability as a function of effective saturation This must be over-ridden in your derived ...
RichardsRelPermAux::_seff_var
const VariableValue & _seff_var
effective saturation
Definition: RichardsRelPermAux.h:34
RichardsRelPermAux::_relperm_UO
const RichardsRelPerm & _relperm_UO
userobject that defines relative permeability function
Definition: RichardsRelPermAux.h:37