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

Go to the source code of this file.

Classes

class  PorousFlowDictator
 This holds maps between the nonlinear variables used in a PorousFlow simulation and the variable number used internally by MOOSE, as well as the number of fluid phases and the number of fluid components. More...
 

Functions

template<>
InputParameters validParams< PorousFlowDictator > ()
 

Function Documentation

template<>
InputParameters validParams< PorousFlowDictator > ( )

Definition at line 15 of file PorousFlowDictator.C.

16 {
17  InputParameters params = validParams<GeneralUserObject>();
18  params.addClassDescription("Holds information on the PorousFlow variable names");
19  params.addRequiredCoupledVar("porous_flow_vars",
20  "List of primary variables that are used in the PorousFlow "
21  "simulation. Jacobian entries involving derivatives wrt these "
22  "variables will be computed. In single-phase models you will just "
23  "have one (eg \'pressure\'), in two-phase models you will have two "
24  "(eg \'p_water p_gas\', or \'p_water s_water\'), etc.");
25  params.addRequiredParam<unsigned int>("number_fluid_phases",
26  "The number of fluid phases in the simulation");
27  params.addRequiredParam<unsigned int>("number_fluid_components",
28  "The number of fluid components in the simulation");
29  return params;
30 }