RichardsSeffAux Class Reference

Calculates effective saturation for a specified variable. More...

#include <RichardsSeffAux.h>

Inheritance diagram for RichardsSeffAux:

Public Member Functions
	RichardsSeffAux (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue ()

Protected Attributes
const RichardsSeff &	_seff_UO
	The user object that defines effective saturation as function of porepressure (or porepressures in the multiphase situation) More...
std::vector< const VariableValue * >	_pressure_vals
	the porepressure values (this will be length N where N is the number of arguments that the _seff_UO requires) Eg, for twophase simulations N=2 More...

Detailed Description

Calculates effective saturation for a specified variable.

Definition at line 25 of file RichardsSeffAux.h.

Constructor & Destructor Documentation

RichardsSeffAux()

RichardsSeffAux::RichardsSeffAux

(

const InputParameters &

parameters

)

Definition at line 28 of file RichardsSeffAux.C.

  : AuxKernel(parameters), _seff_UO(getUserObject<RichardsSeff>("seff_UO"))
{
  int n = coupledComponents("pressure_vars");
  _pressure_vals.resize(n);
 
  for (int i = 0; i < n; ++i)
    _pressure_vals[i] = &coupledValue("pressure_vars", i);
}

Member Function Documentation

computeValue()

Real RichardsSeffAux::computeValue ( )

protectedvirtual

Definition at line 39 of file RichardsSeffAux.C.

{
  return _seff_UO.seff(_pressure_vals, _qp);
}

Member Data Documentation

_pressure_vals

std::vector<const VariableValue *> RichardsSeffAux::_pressure_vals

protected

the porepressure values (this will be length N where N is the number of arguments that the _seff_UO requires) Eg, for twophase simulations N=2

Definition at line 45 of file RichardsSeffAux.h.

Referenced by computeValue(), and RichardsSeffAux().

_seff_UO

const RichardsSeff& RichardsSeffAux::_seff_UO

protected

The user object that defines effective saturation as function of porepressure (or porepressures in the multiphase situation)

Definition at line 38 of file RichardsSeffAux.h.

Referenced by computeValue().

---

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

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