Classes | Functions
MultiBoundingBoxIC.h File Reference

Go to the source code of this file.


class  MultiBoundingBoxIC
 MultiBoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. More...


InputParameters validParams< MultiBoundingBoxIC > ()

Function Documentation

InputParameters validParams< MultiBoundingBoxIC > ( )

Definition at line 13 of file MultiBoundingBoxIC.C.

14 {
15  InputParameters params = validParams<InitialCondition>();
16  params.addClassDescription("Specify variable values inside and outside a list of box shaped "
17  "axis-aligned regions defined by pairs of opposing corners");
18  params.addRequiredParam<std::vector<Point>>("corners", "The corner coordinates boxes");
19  params.addRequiredParam<std::vector<Point>>(
20  "opposite_corners", "The coordinates of the opposite corners of the boxes");
21  params.addRequiredParam<std::vector<Real>>("inside",
22  "The value of the variable inside each box "
23  "(one value per box or a single value for "
24  "all boxes)");
25  params.addParam<Real>("outside", 0.0, "The value of the variable outside the box");
26  return params;
27 }