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

Go to the source code of this file.

Classes

class  RndBoundingBoxIC
 RndBoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. More...
 

Functions

template<>
InputParameters validParams< RndBoundingBoxIC > ()
 

Function Documentation

template<>
InputParameters validParams< RndBoundingBoxIC > ( )

Definition at line 12 of file RndBoundingBoxIC.C.

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