www.mooseframework.org
Classes | Functions
RichardsHalfGaussianSinkFlux.h File Reference

Go to the source code of this file.

Classes

class  RichardsHalfGaussianSinkFlux
 Postprocessor that records the mass flux from porespace to a half-gaussian sink. More...
 

Functions

template<>
InputParameters validParams< RichardsHalfGaussianSinkFlux > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsHalfGaussianSinkFlux > ( )

Definition at line 16 of file RichardsHalfGaussianSinkFlux.C.

17 {
18  InputParameters params = validParams<SideIntegralVariablePostprocessor>();
19  params.addRequiredParam<Real>("max",
20  "Maximum of the flux (measured in kg.m^-2.s^-1). Flux out "
21  "= max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and Flux "
22  "out = max for p>centre. Note, to make this a source "
23  "rather than a sink, let max<0");
24  params.addRequiredParam<Real>("sd",
25  "Standard deviation of the Gaussian (measured in Pa). Flux "
26  "out = max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and "
27  "Flux out = max for p>centre.");
28  params.addRequiredParam<Real>("centre",
29  "Centre of the Gaussian (measured in Pa). Flux out = "
30  "max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and "
31  "Flux out = max for p>centre.");
32  params.addParam<FunctionName>(
33  "multiplying_fcn",
34  1.0,
35  "The flux will be multiplied by this spatially-and-temporally varying function.");
36  params.addRequiredParam<UserObjectName>(
37  "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
38  return params;
39 }