PorousFlowFullySaturatedDarcyBase.h File Reference

Go to the source code of this file.

Classes
class	PorousFlowFullySaturatedDarcyBase
	Darcy advective flux for a fully-saturated, single phase, single component fluid. More...

Functions
template<>
InputParameters	validParams< PorousFlowFullySaturatedDarcyBase > ()

Function Documentation

validParams< PorousFlowFullySaturatedDarcyBase >()

template<>

InputParameters validParams< PorousFlowFullySaturatedDarcyBase >

(

)

Definition at line 18 of file PorousFlowFullySaturatedDarcyBase.C.

{
  InputParameters params = validParams<Kernel>();
  params.addRequiredParam<RealVectorValue>("gravity",
                                           "Gravitational acceleration vector downwards (m/s^2)");
  params.addParam<bool>("multiply_by_density",
                        true,
                        "If true, then this Kernel is the fluid mass "
                        "flux.  If false, then this Kernel is the "
                        "fluid volume flux (which is common in "
                        "poro-mechanics)");
  params.addRequiredParam<UserObjectName>(
      "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
  params.addClassDescription("Darcy flux suitable for models involving a fully-saturated, single "
                             "phase, single component fluid.  No upwinding is used");
  return params;
}

Referenced by validParams< PorousFlowFullySaturatedDarcyFlow >(), and validParams< PorousFlowFullySaturatedHeatAdvection >().