MultiBoundingBoxIC.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", MultiBoundingBoxIC)
template<>
InputParameters	validParams< MultiBoundingBoxIC > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		MultiBoundingBoxIC
	)

validParams< MultiBoundingBoxIC >()

template<>

InputParameters validParams< MultiBoundingBoxIC >

(

)

Definition at line 30 of file MultiBoundingBoxIC.C.

{
  InputParameters params = validParams<InitialCondition>();
  params.addClassDescription("Specify variable values inside and outside a list of box shaped "
                             "axis-aligned regions defined by pairs of opposing corners");
  params.addRequiredParam<std::vector<Point>>("corners", "The corner coordinates boxes");
  params.addRequiredParam<std::vector<Point>>(
      "opposite_corners", "The coordinates of the opposite corners of the 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)");
  params.addParam<Real>("outside", 0.0, "The value of the variable outside the box");
 
  params.addClassDescription("Allows setting the initial condition of a value of a field inside "
                             "and outside multiple bounding boxes.");
  return params;
}