PolycrystalVoronoiVoidIC.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalVoronoiVoidIC
	PolycrystalVoronoiVoidIC initializes either grain or void values for a voronoi tesselation with voids distributed along the grain boundaries. More...
struct	PolycrystalVoronoiVoidIC::DistancePoint
	Type for distance and point. More...
struct	PolycrystalVoronoiVoidIC::DistancePointComparator
	Sorts the temp_centerpoints into order of magnitude. More...

Functions
template<>
InputParameters	validParams< PolycrystalVoronoiVoidIC > ()

Function Documentation

validParams< PolycrystalVoronoiVoidIC >()

template<>

InputParameters validParams< PolycrystalVoronoiVoidIC >

(

)

Definition at line 36 of file PolycrystalVoronoiVoidIC.C.

{
  InputParameters params = PolycrystalVoronoiVoidIC::actionParameters();
  MooseEnum structure_options("grains voids");
  params.addRequiredParam<MooseEnum>("structure_type",
                                     structure_options,
                                     "Which structure type is being initialized, grains or voids");
  params.addParam<unsigned int>("op_index",
                                0,
                                "The index for the current "
                                "order parameter, not needed if "
                                "structure_type = voids");
  params.addRequiredParam<UserObjectName>(
      "polycrystal_ic_uo", "UserObject for obtaining the polycrystal grain structure.");
  params.addParam<FileName>(
      "file_name",
      "",
      "File containing grain centroids, if file_name is provided, the centroids "
      "from the file will be used.");
  return params;
}