www.mooseframework.org
Functions
RichardsExcavGeom.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RichardsExcavGeom > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsExcavGeom > ( )

Definition at line 12 of file RichardsExcavGeom.C.

13 {
14  InputParameters params = validParams<Function>();
15  params.addRequiredParam<RealVectorValue>(
16  "start_posn",
17  "Start point of the excavation. This is an (x,y,z) point in the middle of the "
18  "coal face at the very beginning of the panel.");
19  params.addRequiredParam<Real>("start_time", "Commencement time of the excavation");
20  params.addRequiredParam<RealVectorValue>("end_posn",
21  "End position of the excavation. This is "
22  "an (x,y,z) point in the middle of the coal "
23  "face at the very end of the panel.");
24  params.addRequiredParam<Real>("end_time", "Time at the completion of the excavation");
25  params.addRequiredParam<Real>("active_length",
26  "This function is only active at a point if the "
27  "distance between the point and the coal face <= "
28  "active_length.");
29  params.addParam<Real>("true_value",
30  1.0,
31  "Return this value if a point is in the active zone. "
32  "This is usually used for controlling "
33  "permeability-changes");
34  params.addParam<Real>(
35  "deactivation_time", 1.0E30, "Time at which this function is totally turned off");
36  params.addClassDescription("This function defines excavation geometry. It can be used to "
37  "enforce pressures at the boundary of excavations, and to record "
38  "fluid fluxes into excavations.");
39  return params;
40 }