RndBoundingBoxIC.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		RndBoundingBoxIC
	)

validParams< RndBoundingBoxIC >()

template<>

InputParameters validParams< RndBoundingBoxIC >

(

)

Definition at line 17 of file RndBoundingBoxIC.C.

{
  InputParameters params = validParams<InitialCondition>();
  params.addClassDescription(
      "Random noise with different min/max inside/outside of a bounding box");
 
  params.addRequiredParam<Real>("x1", "The x coordinate of the lower left-hand corner of the box");
  params.addRequiredParam<Real>("y1", "The y coordinate of the lower left-hand corner of the 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.addRequiredParam<Real>("mx_invalue", "The max value of the variable invalue the box");
  params.addRequiredParam<Real>("mx_outvalue", "The max value of the variable outvalue the box");
 
  params.addParam<Real>("mn_invalue", 0.0, "The min value of the variable invalue the box");
  params.addParam<Real>("mn_outvalue", 0.0, "The min value of the variable outvalue the box");
  return params;
}