RichardsExcav.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"RichardsApp"	,
		RichardsExcav
	)

validParams< RichardsExcav >()

template<>

InputParameters validParams< RichardsExcav >

(

)

Definition at line 19 of file RichardsExcav.C.

{
  InputParameters params = validParams<NodalBC>();
  params.addRequiredParam<Real>(
      "p_excav",
      "Value of the variable at the surface of the excavation.  Eg atmospheric pressure");
  params.addRequiredParam<FunctionName>(
      "excav_geom_function",
      "The function describing the excavation geometry (type RichardsExcavGeom)");
  params.addClassDescription("Allows the user to set variable values at the face of an excavation. "
                             " You must have defined the excavation start time, start position, "
                             "etc, through the excav_geom_function");
  return params;
}