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

validParams< PorousFlowSinglePhaseBase >()

template<>

InputParameters validParams< PorousFlowSinglePhaseBase >

(

)

Definition at line 18 of file PorousFlowSinglePhaseBase.C.

{
  InputParameters params = validParams<PorousFlowActionBase>();
  params.addParam<bool>("add_darcy_aux", true, "Add AuxVariables that record Darcy velocity");
  params.addParam<bool>("add_stress_aux", true, "Add AuxVariables that record effective stress");
  params.addParam<bool>("use_brine", false, "Use PorousFlowBrine material for the fluid phase");
  params.addRequiredParam<VariableName>("porepressure", "The name of the porepressure variable");
  MooseEnum coupling_type("Hydro ThermoHydro HydroMechanical ThermoHydroMechanical", "Hydro");
  params.addParam<MooseEnum>("coupling_type",
                             coupling_type,
                             "The type of simulation.  For simulations involving Mechanical "
                             "deformations, you will need to supply the correct Biot coefficient.  "
                             "For simulations involving Thermal flows, you will need an associated "
                             "ConstantThermalExpansionCoefficient Material");
  MooseEnum simulation_type_choice("steady transient", "transient");
  params.addDeprecatedParam<MooseEnum>(
      "simulation_type",
      simulation_type_choice,
      "Whether a transient or steady-state simulation is being performed",
      "The execution type is now determined automatically. This parameter should no longer be "
      "used");
  params.addParam<UserObjectName>("fp",
                                  "use_brine_material",
                                  "The name of the user object for fluid "
                                  "properties. Not required if use_brine is true.");
  params.addCoupledVar("mass_fraction_vars",
                       "List of variables that represent the mass fractions.  With only one fluid "
                       "component, this may be left empty.  With N fluid components, the format is "
                       "'f_0 f_1 f_2 ... f_(N-1)'.  That is, the N^th component need not be "
                       "specified because f_N = 1 - (f_0 + f_1 + ... + f_(N-1)).  It is best "
                       "numerically to choose the N-1 mass fraction variables so that they "
                       "represent the fluid components with small concentrations.  This Action "
                       "will associated the i^th mass fraction variable to the equation for the "
                       "i^th fluid component, and the pressure variable to the N^th fluid "
                       "component.");
  params.addParam<unsigned>("nacl_index",
                            0,
                            "Index of NaCl variable in mass_fraction_vars, for "
                            "calculating brine properties. Only required if use_brine is true.");
  params.addParam<Real>(
      "biot_coefficient",
      1.0,
      "The Biot coefficient (relevant only for mechanically-coupled simulations)");
  params.addClassDescription("Base class for single-phase simulations");
  return params;
}

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