PFCFreezingIC.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", PFCFreezingIC)
template<>
InputParameters	validParams< PFCFreezingIC > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		PFCFreezingIC
	)

validParams< PFCFreezingIC >()

template<>

InputParameters validParams< PFCFreezingIC >

(

)

Definition at line 17 of file PFCFreezingIC.C.

{
  InputParameters params = validParams<RandomICBase>();
  params.addRequiredParam<Real>("x1",
                                "The x coordinate of the lower left-hand corner of the frozen box");
  params.addRequiredParam<Real>("y1",
                                "The y coordinate of the lower left-hand corner of the frozen box");
  params.addParam<Real>("z1", 0.0, "The z coordinate of the lower left-hand corner of the box");
 
  params.addRequiredParam<Real>("x2", "The x coordinate of the upper right-hand corner of the box");
  params.addRequiredParam<Real>("y2", "The y coordinate of the upper right-hand corner of the box");
  params.addParam<Real>("z2", 0.0, "The z coordinate of the upper right-hand corner of the box");
 
  params.addParam<Real>("min", 0.0, "Lower bound of the randomly generated values");
  params.addParam<Real>("max", 1.0, "Upper bound of the randomly generated values");
  params.addParam<Real>("inside", 1.0, "Value inside sinusoids");
  params.addParam<Real>("outside", 0.0, "Value outside sinusoids");
 
  params.addRequiredParam<Real>("lc", "The lattice constant off the crystal structure");
 
  MooseEnum crystal_structures("FCC BCC");
  params.addParam<MooseEnum>(
      "crystal_structure", crystal_structures, "The type of crystal structure");
 
  return params;
}