PorousFlowDarcyVelocityComponent.C File Reference

Go to the source code of this file.


InputParameters validParams< PorousFlowDarcyVelocityComponent > ()

Function Documentation

InputParameters validParams< PorousFlowDarcyVelocityComponent > ( )

Definition at line 18 of file PorousFlowDarcyVelocityComponent.C.

19 {
20  InputParameters params = validParams<AuxKernel>();
21  params.addRequiredParam<RealVectorValue>("gravity",
22  "Gravitational acceleration vector downwards (m/s^2)");
23  params.addRequiredParam<UserObjectName>(
24  "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names");
25  params.addParam<unsigned int>("fluid_phase", 0, "The index corresponding to the fluid phase");
26  MooseEnum component("x=0 y=1 z=2");
27  params.addRequiredParam<MooseEnum>(
28  "component", component, "The spatial component of the Darcy flux to return");
29  params.addClassDescription("Darcy velocity (in m^3.s^-1.m^-2, or m.s^-1) -(k_ij * krel /mu "
30  "(nabla_j P - w_j)), where k_ij is the permeability tensor, krel is "
31  "the relative permeability, mu is the fluid viscosity, P is the fluid "
32  "pressure, and w_j is the fluid weight.");
33  return params;
34 }
Real component(const SymmTensor &symm_tensor, unsigned int index)