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

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

#include <RichardsSeffAux.h>

Inheritance diagram for RichardsSeffAux:
[legend]

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

Constructor & Destructor Documentation

RichardsSeffAux::RichardsSeffAux ( const InputParameters &  parameters)

Definition at line 24 of file RichardsSeffAux.C.

25  : AuxKernel(parameters), _seff_UO(getUserObject<RichardsSeff>("seff_UO"))
26 {
27  int n = coupledComponents("pressure_vars");
28  _pressure_vals.resize(n);
29 
30  for (int i = 0; i < n; ++i)
31  _pressure_vals[i] = &coupledValue("pressure_vars", i);
32 }
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 r...
const RichardsSeff & _seff_UO
The user object that defines effective saturation as function of porepressure (or porepressures in th...

Member Function Documentation

Real RichardsSeffAux::computeValue ( )
protectedvirtual

Definition at line 35 of file RichardsSeffAux.C.

36 {
37  return _seff_UO.seff(_pressure_vals, _qp);
38 }
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 r...
const RichardsSeff & _seff_UO
The user object that defines effective saturation as function of porepressure (or porepressures in th...
virtual Real seff(std::vector< const VariableValue * > p, unsigned int qp) const =0
effective saturation as a function of porepressure(s) at given quadpoint of the element ...

Member Data Documentation

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 44 of file RichardsSeffAux.h.

Referenced by computeValue(), and RichardsSeffAux().

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 37 of file RichardsSeffAux.h.

Referenced by computeValue().


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