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

Go to the source code of this file.

Classes

class  PorousFlowSinglePhaseBase
 Base class for actions involving a single fluid phase. More...
 

Functions

template<>
InputParameters validParams< PorousFlowSinglePhaseBase > ()
 

Function Documentation

template<>
InputParameters validParams< PorousFlowSinglePhaseBase > ( )

Definition at line 15 of file PorousFlowSinglePhaseBase.C.

Referenced by validParams< PorousFlowBasicTHM >(), validParams< PorousFlowFullySaturated >(), and validParams< PorousFlowUnsaturated >().

16 {
17  InputParameters params = validParams<PorousFlowActionBase>();
18  params.addParam<bool>("add_darcy_aux", true, "Add AuxVariables that record Darcy velocity");
19  params.addParam<bool>("add_stress_aux", true, "Add AuxVariables that record effective stress");
20  params.addParam<bool>("use_brine", false, "Use PorousFlowBrine material for the fluid phase");
21  params.addRequiredParam<NonlinearVariableName>("porepressure",
22  "The name of the porepressure variable");
23  MooseEnum coupling_type("Hydro ThermoHydro HydroMechanical ThermoHydroMechanical", "Hydro");
24  params.addParam<MooseEnum>("coupling_type",
25  coupling_type,
26  "The type of simulation. For simulations involving Mechanical "
27  "deformations, you will need to supply the correct Biot coefficient. "
28  "For simulations involving Thermal flows, you will need an associated "
29  "ConstantThermalExpansionCoefficient Material");
30  MooseEnum simulation_type_choice("steady transient", "transient");
31  params.addParam<MooseEnum>("simulation_type",
32  simulation_type_choice,
33  "Whether a transient or steady-state simulation is being performed");
34  params.addParam<UserObjectName>("fp",
35  "use_brine_material",
36  "The name of the user object for fluid "
37  "properties. Not required if use_brine is true.");
38  params.addCoupledVar("mass_fraction_vars",
39  "List of variables that represent the mass fractions. With only one fluid "
40  "component, this may be left empty. With N fluid components, the format is "
41  "'f_0 f_1 f_2 ... f_(N-1)'. That is, the N^th component need not be "
42  "specified because f_N = 1 - (f_0 + f_1 + ... + f_(N-1)). It is best "
43  "numerically to choose the N-1 mass fraction variables so that they "
44  "represent the fluid components with small concentrations. This Action "
45  "will associated the i^th mass fraction variable to the equation for the "
46  "i^th fluid component, and the pressure variable to the N^th fluid "
47  "component.");
48  params.addParam<unsigned>("nacl_index",
49  0,
50  "Index of NaCl variable in mass_fraction_vars, for "
51  "calculating brine properties. Only required if use_brine is true.");
52  params.addParam<Real>(
53  "biot_coefficient",
54  1.0,
55  "The Biot coefficient (relevant only for mechanically-coupled simulations)");
56  params.addClassDescription("Base class for single-phase simulations");
57  return params;
58 }
InputParameters validParams< PorousFlowActionBase >()