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

Go to the source code of this file.

Classes

class  PorousFlowActionBase
 Base class for PorousFlow actions. More...
 

Functions

template<>
InputParameters validParams< PorousFlowActionBase > ()
 

Function Documentation

template<>
InputParameters validParams< PorousFlowActionBase > ( )

Definition at line 16 of file PorousFlowActionBase.C.

Referenced by validParams< PorousFlowSinglePhaseBase >().

17 {
18  InputParameters params = validParams<Action>();
19  params.addParam<std::string>(
20  "dictator_name",
21  "dictator",
22  "The name of the dictator user object that is created by this Action");
23  params.addClassDescription("Adds the PorousFlowDictator UserObject. This class also contains "
24  "many utility functions for adding other pieces of an input file, "
25  "which may be used by derived classes.");
26  params.addParam<RealVectorValue>("gravity",
27  RealVectorValue(0.0, 0.0, -10.0),
28  "Gravitational acceleration vector downwards (m/s^2)");
29  params.addCoupledVar("temperature",
30  293.0,
31  "For isothermal simulations, this is the temperature "
32  "at which fluid properties (and stress-free strains) "
33  "are evaluated at. Otherwise, this is the name of "
34  "the temperature variable. Units = Kelvin");
35  params.addCoupledVar("mass_fraction_vars",
36  "List of variables that represent the mass fractions. Format is 'f_ph0^c0 "
37  "f_ph0^c1 f_ph0^c2 ... f_ph0^c(N-1) f_ph1^c0 f_ph1^c1 fph1^c2 ... "
38  "fph1^c(N-1) ... fphP^c0 f_phP^c1 fphP^c2 ... fphP^c(N-1)' where "
39  "N=num_components and P=num_phases, and it is assumed that "
40  "f_ph^cN=1-sum(f_ph^c,{c,0,N-1}) so that f_ph^cN need not be given. If no "
41  "variables are provided then num_phases=1=num_components.");
42  params.addParam<std::vector<NonlinearVariableName>>(
43  "displacements",
44  "The name of the displacement variables (relevant only for "
45  "mechanically-coupled simulations)");
46  params.addParam<std::string>("thermal_eigenstrain_name",
47  "thermal_eigenstrain",
48  "The eigenstrain_name used in the "
49  "ComputeThermalExpansionEigenstrain. Only needed for "
50  "thermally-coupled simulations with thermal expansion.");
51  params.addParam<bool>(
52  "use_displaced_mesh", false, "Use displaced mesh computations in mechanical kernels");
53  return params;
54 }