www.mooseframework.org
Classes | Functions
PolycrystalColoringIC.h File Reference

Go to the source code of this file.

Classes

class  PolycrystalColoringIC
 PolycrystalColoringIC creates a polycrystal initial condition. More...
 

Functions

template<>
InputParameters validParams< PolycrystalColoringIC > ()
 

Function Documentation

◆ validParams< PolycrystalColoringIC >()

template<>
InputParameters validParams< PolycrystalColoringIC > ( )

Definition at line 22 of file PolycrystalColoringIC.C.

23 {
24  InputParameters params = validParams<InitialCondition>();
25  params.addClassDescription(
26  "Random Voronoi tesselation polycrystal (used by PolycrystalVoronoiICAction)");
27  params.addRequiredParam<UserObjectName>("polycrystal_ic_uo",
28  "User object generating a point to grain number mapping");
29  params.addRequiredParam<unsigned int>("op_index", "The index for the current order parameter");
30 
31  return params;
32 }