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

Go to the source code of this file.

Classes

class  PolycrystalRandomIC
 Random initial condition for a polycrystalline material. More...
 

Functions

template<>
InputParameters validParams< PolycrystalRandomIC > ()
 

Function Documentation

template<>
InputParameters validParams< PolycrystalRandomIC > ( )

Definition at line 13 of file PolycrystalRandomIC.C.

14 {
15  InputParameters params = validParams<InitialCondition>();
16  params.addClassDescription("Random initial condition for a polycrystalline material");
17  params.addRequiredParam<unsigned int>("op_num", "Number of order parameters");
18  params.addRequiredParam<unsigned int>("op_index", "The index for the current order parameter");
19  params.addRequiredParam<unsigned int>(
20  "typ", "Type of random grain structure"); // TODO: this should be called "type"!
21  return params;
22 }