RichardsExcavFlow.h File Reference

Go to the source code of this file.

Classes
class	RichardsExcavFlow
	Records total mass flow into an excavation defined by a RichardsExcavGeom function. More...

Functions
template<>
InputParameters	validParams< RichardsExcavFlow > ()

Function Documentation

validParams< RichardsExcavFlow >()

template<>

InputParameters validParams< RichardsExcavFlow >

(

)

Definition at line 18 of file RichardsExcavFlow.C.

{
  InputParameters params = validParams<SideIntegralVariablePostprocessor>();
  params.addRequiredParam<FunctionName>(
      "excav_geom_function",
      "The function describing the excavation geometry (type RichardsExcavGeom)");
  params.addRequiredParam<UserObjectName>(
      "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
  params.addClassDescription("Records total flow INTO an excavation (if quantity is positive then "
                             "flow has occured from rock into excavation void)");
  return params;
}