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

validParams< PorousFlowActionBase >()

template<>

InputParameters validParams< PorousFlowActionBase >

(

)

Definition at line 22 of file PorousFlowActionBase.C.

{
  InputParameters params = validParams<Action>();
  params.addParam<std::string>(
      "dictator_name",
      "dictator",
      "The name of the dictator user object that is created by this Action");
  params.addClassDescription("Adds the PorousFlowDictator UserObject.  This class also contains "
                             "many utility functions for adding other pieces of an input file, "
                             "which may be used by derived classes.");
  params.addParam<RealVectorValue>("gravity",
                                   RealVectorValue(0.0, 0.0, -10.0),
                                   "Gravitational acceleration vector downwards (m/s^2)");
  params.addCoupledVar("temperature",
                       293.0,
                       "For isothermal simulations, this is the temperature "
                       "at which fluid properties (and stress-free strains) "
                       "are evaluated at.  Otherwise, this is the name of "
                       "the temperature variable.  Units = Kelvin");
  params.addCoupledVar("mass_fraction_vars",
                       "List of variables that represent the mass fractions.  Format is 'f_ph0^c0 "
                       "f_ph0^c1 f_ph0^c2 ... f_ph0^c(N-1) f_ph1^c0 f_ph1^c1 fph1^c2 ... "
                       "fph1^c(N-1) ... fphP^c0 f_phP^c1 fphP^c2 ... fphP^c(N-1)' where "
                       "N=num_components and P=num_phases, and it is assumed that "
                       "f_ph^cN=1-sum(f_ph^c,{c,0,N-1}) so that f_ph^cN need not be given.  If no "
                       "variables are provided then num_phases=1=num_components.");
  params.addParam<unsigned int>("number_aqueous_equilibrium",
                                0,
                                "The number of secondary species in the aqueous-equilibrium "
                                "reaction system.  (Leave as zero if the simulation does not "
                                "involve chemistry)");
  params.addParam<unsigned int>("number_aqueous_kinetic",
                                0,
                                "The number of secondary species in the aqueous-kinetic reaction "
                                "system involved in precipitation and dissolution.  (Leave as zero "
                                "if the simulation does not involve chemistry)");
  params.addParam<std::vector<VariableName>>(
      "displacements",
      "The name of the displacement variables (relevant only for "
      "mechanically-coupled simulations)");
  params.addParam<std::string>("thermal_eigenstrain_name",
                               "thermal_eigenstrain",
                               "The eigenstrain_name used in the "
                               "ComputeThermalExpansionEigenstrain.  Only needed for "
                               "thermally-coupled simulations with thermal expansion.");
  params.addParam<bool>(
      "use_displaced_mesh", false, "Use displaced mesh computations in mechanical kernels");
  MooseEnum flux_limiter_type("MinMod VanLeer MC superbee None", "VanLeer");
  params.addParam<MooseEnum>(
      "flux_limiter_type",
      flux_limiter_type,
      "Type of flux limiter to use if stabilization=KT.  'None' means that no antidiffusion "
      "will be added in the Kuzmin-Turek scheme");
  MooseEnum stabilization("Full KT", "Full");
  params.addParam<MooseEnum>("stabilization",
                             stabilization,
                             "Numerical stabilization used.  'Full' means full upwinding.  'KT' "
                             "means FEM-TVD stabilization of Kuzmin-Turek");
  return params;
}

Referenced by validParams< PorousFlowSinglePhaseBase >().