www.mooseframework.org
Functions
DarcyFluxComponent.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< DarcyFluxComponent > ()
 

Function Documentation

template<>
InputParameters validParams< DarcyFluxComponent > ( )

Definition at line 18 of file DarcyFluxComponent.C.

19 {
20  MooseEnum component("x=0 y=1 z=2");
21  InputParameters params = validParams<AuxKernel>();
22  params.addRequiredParam<RealVectorValue>(
23  "fluid_weight",
24  "Fluid weight (gravity*density) as a vector pointing downwards (usually "
25  "measured in kg.m^-2.s^-2 = Pa/m). Eg '0 0 -10000'");
26  params.addRequiredParam<Real>("fluid_viscosity",
27  "Fluid dynamic viscosity (usually measured in Pa.s)");
28  params.addClassDescription("Darcy flux (in m^3.s^-1.m^-2, or m.s^-1) -(k_ij/mu (nabla_j P - "
29  "w_j)), where k_ij is the permeability tensor, mu is the fluid "
30  "viscosity, P is the fluid pressure, and w_j is the fluid weight. If "
31  "velocity_scaling is used then -(k_ij/mu (nabla_j P - "
32  "w_j))/velocity_scaling is returned");
33  params.addParam<MooseEnum>("component", component, "The component of the Darcy flux to return");
34  params.addParam<Real>(
35  "velocity_scaling",
36  1,
37  "Scale the result by (1/velocity_scaling). Usually velocity_scaling = porosity.");
38  params.addRequiredCoupledVar("porepressure", "The variable representing the porepressure");
39  return params;
40 }
Real component(const SymmTensor &symm_tensor, unsigned int index)