PolycrystalVoronoiVoidICAction.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalVoronoiVoidICAction
	Sets up a polycrystal initial condition with voids on grain boundaries for all order parameters. More...

Functions
template<>
InputParameters	validParams< PolycrystalVoronoiVoidICAction > ()

Function Documentation

validParams< PolycrystalVoronoiVoidICAction >()

template<>

InputParameters validParams< PolycrystalVoronoiVoidICAction >

(

)

Definition at line 20 of file PolycrystalVoronoiVoidICAction.C.

{
  InputParameters params = validParams<Action>();
  params += PolycrystalVoronoiVoidIC::actionParameters();
  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
  params.suppressParameter<VariableName>("variable");
  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;
}