RichardsHalfGaussianSinkFlux.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"RichardsApp"	,
		RichardsHalfGaussianSinkFlux
	)

validParams< RichardsHalfGaussianSinkFlux >()

template<>

InputParameters validParams< RichardsHalfGaussianSinkFlux >

(

)

Definition at line 20 of file RichardsHalfGaussianSinkFlux.C.

{
  InputParameters params = validParams<SideIntegralVariablePostprocessor>();
  params.addRequiredParam<Real>("max",
                                "Maximum of the flux (measured in kg.m^-2.s^-1).  Flux out "
                                "= max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and Flux "
                                "out = max for p>centre.  Note, to make this a source "
                                "rather than a sink, let max<0");
  params.addRequiredParam<Real>("sd",
                                "Standard deviation of the Gaussian (measured in Pa).  Flux "
                                "out = max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and "
                                "Flux out = max for p>centre.");
  params.addRequiredParam<Real>("centre",
                                "Centre of the Gaussian (measured in Pa).  Flux out = "
                                "max*exp((-0.5*(p - centre)/sd)^2) for p<centre, and "
                                "Flux out = max for p>centre.");
  params.addParam<FunctionName>(
      "multiplying_fcn",
      1.0,
      "The flux will be multiplied by this spatially-and-temporally varying function.");
  params.addRequiredParam<UserObjectName>(
      "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
  return params;
}