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

Go to the source code of this file.

Classes

class  RichardsHalfGaussianSink
 Applies a fluid sink to the boundary. More...
 

Functions

template<>
InputParameters validParams< RichardsHalfGaussianSink > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsHalfGaussianSink > ( )

Definition at line 19 of file RichardsHalfGaussianSink.C.

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