BicrystalCircleGrainICAction.h File Reference

Go to the source code of this file.

Classes
class	BicrystalCircleGrainICAction
	Bicrystal with a circular grain and an embedding outer grain. More...

Functions
template<>
InputParameters	validParams< BicrystalCircleGrainICAction > ()

Function Documentation

validParams< BicrystalCircleGrainICAction >()

template<>

InputParameters validParams< BicrystalCircleGrainICAction >

(

)

Definition at line 19 of file BicrystalCircleGrainICAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription("Bicrystal with a circular grain and an embedding outer grain");
  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>("radius", "Void radius");
  params.addRequiredParam<Real>("x", "The x coordinate of the circle grain center");
  params.addRequiredParam<Real>("y", "The y coordinate of the circle grain center");
  params.addParam<Real>("z", 0.0, "The z coordinate of the circle grain center");
  params.addParam<Real>(
      "int_width", 0.0, "The interfacial width of the void surface.  Defaults to sharp interface");
  params.addParam<bool>(
      "3D_sphere", true, "in 3D, whether the smaller grain is a spheres or columnar grain");
  return params;
}