BicrystalBoundingBoxICAction.h File Reference

Go to the source code of this file.

Classes
class	BicrystalBoundingBoxICAction
	Bicrystal using a bounding box. More...

Functions
template<>
InputParameters	validParams< BicrystalBoundingBoxICAction > ()

Function Documentation

validParams< BicrystalBoundingBoxICAction >()

template<>

InputParameters validParams< BicrystalBoundingBoxICAction >

(

)

Definition at line 19 of file BicrystalBoundingBoxICAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription("Constructs a bicrystal, where one grain is on the inside of "
                             "the box and the other grain is the outside of the box");
  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
  params.addRequiredParam<unsigned int>("op_num", "Number of grains, should be 2");
  params.addRequiredParam<Real>("x1", "The x coordinate of the lower left-hand corner of the box");
  params.addRequiredParam<Real>("y1", "The y coordinate of the lower left-hand corner of the box");
  params.addParam<Real>("z1", 0.0, "The z coordinate of the lower left-hand corner of the box");
  params.addRequiredParam<Real>("x2", "The x coordinate of the upper right-hand corner of the box");
  params.addRequiredParam<Real>("y2", "The y coordinate of the upper right-hand corner of the box");
  params.addParam<Real>("z2", 0.0, "The z coordinate of the upper right-hand corner of the box");
  return params;
}