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

Go to the source code of this file.

Classes

class  MovingPlanarFront
 Defines the position of a moving front. More...
 

Functions

template<>
InputParameters validParams< MovingPlanarFront > ()
 

Function Documentation

template<>
InputParameters validParams< MovingPlanarFront > ( )

Definition at line 12 of file MovingPlanarFront.C.

13 {
14  InputParameters params = validParams<Function>();
15  params.addRequiredParam<RealVectorValue>("start_posn", "Initial position of the front");
16  params.addRequiredParam<RealVectorValue>("end_posn", "Final position of the front");
17  params.addRequiredParam<FunctionName>(
18  "distance",
19  "The front is an infinite plane with normal pointing from start_posn to "
20  "end_posn. The front's distance from start_posn is defined by distance. You "
21  "should ensure that distance is positive");
22  params.addRequiredParam<Real>(
23  "active_length",
24  "This function will return true_value at a point if: (a) t >= "
25  "activation_time; (b) t < deactivation_time; (c) the point lies in the "
26  "domain between start_posn and the front position; (d) the distance between "
27  "the point and the front position <= active_length.");
28  params.addParam<Real>("true_value", 1.0, "Return this value if a point is in the active zone.");
29  params.addParam<Real>(
30  "false_value", 0.0, "Return this value if a point is not in the active zone.");
31  params.addParam<Real>("activation_time",
32  std::numeric_limits<Real>::lowest(),
33  "This function will return false_value when t < activation_time");
34  params.addParam<Real>("deactivation_time",
35  std::numeric_limits<Real>::max(),
36  "This function will return false_value when t >= deactivation_time");
37  params.addClassDescription("This function defines the position of a moving front. The front is "
38  "an infinite plane with normal pointing from start_posn to end_posn. "
39  "The front's distance from start_posn is defined by distance");
40  return params;
41 }