SmoothMultiBoundingBoxBaseIC.h File Reference

Go to the source code of this file.

Classes
class	SmoothMultiBoundingBoxBaseIC
	SmoothMultiBoundingBoxBaseIC is the base class for IsolatedBoundingBoxIC and NestedBoundingBoxIC. More...

Functions
template<>
InputParameters	validParams< SmoothMultiBoundingBoxBaseIC > ()

Function Documentation

validParams< SmoothMultiBoundingBoxBaseIC >()

template<>

InputParameters validParams< SmoothMultiBoundingBoxBaseIC >

(

)

Definition at line 15 of file SmoothMultiBoundingBoxBaseIC.C.

{
  InputParameters params = validParams<InitialCondition>();
  params.addRequiredParam<Real>("outside", "Outside value");
  params.addRequiredParam<std::vector<Point>>(
      "smaller_coordinate_corners",
      "For 1D, these are the left points; for 2D, these are the bottom left corners; for 3D, these "
      "are the back bottom left corners. The format is (corner1_x corner1_y corner1_z corner2_x "
      "corner2_y corner2_z ...)");
  params.addRequiredParam<std::vector<Point>>(
      "larger_coordinate_corners",
      "For 1D, these are the right points; for 2D, these are the top right corners; for 3D, these "
      "are the front top right corners. The format is (corner1_x corner1_y corner1_z corner2_x "
      "corner2_y corner2_z ...)");
  params.addRequiredParam<Real>("int_width", "The value of the interfacial width between boxes");
  params.addRequiredParam<std::vector<Real>>("inside",
                                             "The value of the variable inside each box "
                                             "(one value per box or a single value for "
                                             "all boxes)");
  return params;
}

Referenced by validParams< IsolatedBoundingBoxIC >(), and validParams< NestedBoundingBoxIC >().