MovingPlanarFront.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PorousFlowApp", MovingPlanarFront)
template<>
InputParameters	validParams< MovingPlanarFront > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		MovingPlanarFront
	)

validParams< MovingPlanarFront >()

template<>

InputParameters validParams< MovingPlanarFront >

(

)

Definition at line 16 of file MovingPlanarFront.C.

{
  InputParameters params = validParams<Function>();
  params.addRequiredParam<RealVectorValue>("start_posn", "Initial position of the front");
  params.addRequiredParam<RealVectorValue>("end_posn", "Final position of the front");
  params.addRequiredParam<FunctionName>(
      "distance",
      "The front is an infinite plane with normal pointing from start_posn to "
      "end_posn.  The front's distance from start_posn is defined by distance.  You "
      "should ensure that distance is positive");
  params.addParam<Real>(
      "active_length",
      std::numeric_limits<Real>::max(),
      "Points greater than active_length behind the front will return false_value");
  params.addParam<Real>("true_value", 1.0, "Return this value if a point is in the active zone.");
  params.addParam<Real>(
      "false_value", 0.0, "Return this value if a point is not in the active zone.");
  params.addParam<Real>("activation_time",
                        std::numeric_limits<Real>::lowest(),
                        "This function will return false_value when t < activation_time");
  params.addParam<Real>("deactivation_time",
                        std::numeric_limits<Real>::max(),
                        "This function will return false_value when t >= deactivation_time");
  params.addClassDescription(
      "This function defines the position of a moving front.  The front is "
      "an infinite plane with normal pointing from start_posn to end_posn.   The front's distance "
      "from start_posn is defined by 'distance', so if the 'distance' function is time dependent, "
      "the front's position will change with time.  Roughly speaking, the function returns "
      "true_value for points lying in between start_posn and start_posn + distance.  Precisely "
      "speaking, two planes are constructed, both with normal pointing from start_posn to "
      "end_posn.  The first plane passes through start_posn; the second plane passes through "
      "end_posn.  Given a point p and time t, this function returns false_value if ANY of the "
      "following are true: (a) t<activation_time; (b) t>=deactivation_time; (c) p is 'behind' "
      "start_posn (ie, p lies on one side of the start_posn plane and end_posn lies on the other "
      "side); (d) p is 'ahead' of the front (ie, p lies one one side of the front and start_posn "
      "lies on the other side); (e) the distance between p and the front is greater than "
      "active_length.  Otherwise, the point is 'in the active zone' and the function returns "
      "true_value.");
  return params;
}