www.mooseframework.org
Classes | Functions
RichardsVarNames.h File Reference

Go to the source code of this file.

Classes

class  RichardsVarNames
 This holds maps between pressure_var or pressure_var, sat_var used in RichardsMaterial and kernels, etc, and the variable number used internally by MOOSE. More...
 

Functions

template<>
InputParameters validParams< RichardsVarNames > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsVarNames > ( )

Definition at line 15 of file RichardsVarNames.C.

16 {
17  InputParameters params = validParams<GeneralUserObject>();
18  params.addClassDescription("Holds information on the porepressure variable names");
19  params.addRequiredCoupledVar("richards_vars",
20  "List of variables that represent the porepressures or "
21  "(porepressure, saturations). In single-phase models you will just "
22  "have one (eg \'pressure\'), in two-phase models you will have two "
23  "(eg \'p_water p_gas\', or \'p_water s_water\', etc. These names "
24  "must also be used in your kernels and material.");
25  MooseEnum var_types("pppp", "pppp");
26  params.addParam<MooseEnum>(
27  "var_types",
28  var_types,
29  "Variable types for the problem. Eg, 'pppp' means all the variables are pressure variables");
30 
31  return params;
32 }