DarcyFluxComponent.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("RichardsApp", DarcyFluxComponent)
template<>
InputParameters	validParams< DarcyFluxComponent > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"RichardsApp"	,
		DarcyFluxComponent
	)

validParams< DarcyFluxComponent >()

template<>

InputParameters validParams< DarcyFluxComponent >

(

)

Definition at line 16 of file DarcyFluxComponent.C.

{
  MooseEnum component("x=0 y=1 z=2");
  InputParameters params = validParams<AuxKernel>();
  params.addRequiredParam<RealVectorValue>(
      "fluid_weight",
      "Fluid weight (gravity*density) as a vector pointing downwards (usually "
      "measured in kg.m^-2.s^-2 = Pa/m).  Eg '0 0 -10000'");
  params.addRequiredParam<Real>("fluid_viscosity",
                                "Fluid dynamic viscosity (usually measured in Pa.s)");
  params.addClassDescription("Darcy flux (in m^3.s^-1.m^-2, or m.s^-1)  -(k_ij/mu (nabla_j P - "
                             "w_j)), where k_ij is the permeability tensor, mu is the fluid "
                             "viscosity, P is the fluid pressure, and w_j is the fluid weight.  If "
                             "velocity_scaling is used then -(k_ij/mu (nabla_j P - "
                             "w_j))/velocity_scaling is returned");
  params.addParam<MooseEnum>("component", component, "The component of the Darcy flux to return");
  params.addParam<Real>(
      "velocity_scaling",
      1,
      "Scale the result by (1/velocity_scaling).  Usually velocity_scaling = porosity.");
  params.addRequiredCoupledVar("porepressure", "The variable representing the porepressure");
  return params;
}