www.mooseframework.org
Functions
PFCFreezingIC.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< PFCFreezingIC > ()
 

Function Documentation

template<>
InputParameters validParams< PFCFreezingIC > ( )

Definition at line 13 of file PFCFreezingIC.C.

14 {
15  InputParameters params = validParams<InitialCondition>();
16  params.addRequiredParam<Real>("x1",
17  "The x coordinate of the lower left-hand corner of the frozen box");
18  params.addRequiredParam<Real>("y1",
19  "The y coordinate of the lower left-hand corner of the frozen box");
20  params.addParam<Real>("z1", 0.0, "The z coordinate of the lower left-hand corner of the box");
21 
22  params.addRequiredParam<Real>("x2", "The x coordinate of the upper right-hand corner of the box");
23  params.addRequiredParam<Real>("y2", "The y coordinate of the upper right-hand corner of the box");
24  params.addParam<Real>("z2", 0.0, "The z coordinate of the upper right-hand corner of the box");
25 
26  params.addParam<Real>("min", 0.0, "Lower bound of the randomly generated values");
27  params.addParam<Real>("max", 1.0, "Upper bound of the randomly generated values");
28  params.addParam<Real>("inside", 1.0, "Value inside sinusoids");
29  params.addParam<Real>("outside", 0.0, "Value outside sinusoids");
30 
31  params.addRequiredParam<Real>("lc", "The lattice constant off the crystal structure");
32 
33  MooseEnum crystal_structures("FCC BCC");
34  params.addParam<MooseEnum>(
35  "crystal_structure", crystal_structures, "The type of crystal structure");
36 
37  params.addParam<unsigned int>("seed", 0, "Seed value for the random number generator");
38 
39  return params;
40 }