RndBoundingBoxIC

under construction:Undocumented Class

The RndBoundingBoxIC has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Random noise with different min/max inside/outside of a bounding box

Input Parameters

  • y2The y coordinate of the upper right-hand corner of the box

    C++ Type:double

    Options:

    Description:The y coordinate of the upper right-hand corner of the box

  • y1The y coordinate of the lower left-hand corner of the box

    C++ Type:double

    Options:

    Description:The y coordinate of the lower left-hand corner of the box

  • x2The x coordinate of the upper right-hand corner of the box

    C++ Type:double

    Options:

    Description:The x coordinate of the upper right-hand corner of the box

  • variableThe variable this initial condition is supposed to provide values for.

    C++ Type:VariableName

    Options:

    Description:The variable this initial condition is supposed to provide values for.

  • mx_invalueThe max value of the variable invalue the box

    C++ Type:double

    Options:

    Description:The max value of the variable invalue the box

  • mx_outvalueThe max value of the variable outvalue the box

    C++ Type:double

    Options:

    Description:The max value of the variable outvalue the box

  • x1The x coordinate of the lower left-hand corner of the box

    C++ Type:double

    Options:

    Description:The x coordinate of the lower left-hand corner of the box

Required Parameters

  • mn_outvalue0The min value of the variable outvalue the box

    Default:0

    C++ Type:double

    Options:

    Description:The min value of the variable outvalue the box

  • mn_invalue0The min value of the variable invalue the box

    Default:0

    C++ Type:double

    Options:

    Description:The min value of the variable invalue the box

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • z10The z coordinate of the lower left-hand corner of the box

    Default:0

    C++ Type:double

    Options:

    Description:The z coordinate of the lower left-hand corner of the box

  • z20The z coordinate of the upper right-hand corner of the box

    Default:0

    C++ Type:double

    Options:

    Description:The z coordinate of the upper right-hand corner of the box

Optional Parameters

  • ignore_uo_dependencyFalseWhen set to true, a UserObject retrieved by this IC will not be executed before the this IC

    Default:False

    C++ Type:bool

    Options:

    Description:When set to true, a UserObject retrieved by this IC will not be executed before the this IC

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

References