BoundingBoxIC

BoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. The box is aligned with the x, y, z axes and is specified by passing in the x, y, z coordinates of the bottom left point and the top right point. Each of the coordinates of the "bottom_left" point MUST be less than those coordinates in the "top_right" point.

When setting the initial condition, if bottom_left <= Point <= top_right then the "inside" value is used. Otherwise the "outside" value is used.

note

When using this IC, only a single bounding box my be specified within the domain. If multiple bounding boxes are needed, this capability is implemented in the phase_field module as MultiBoundingBoxIC.

Class Description

BoundingBoxIC allows setting the initial condition of a value inside and outside of a specified box. The box is aligned with the x, y, z axes

Input Parameters

  • 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.

  • 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

  • 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

  • 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

Required Parameters

  • inside0The value of the variable inside the box

    Default:0

    C++ Type:double

    Options:

    Description:The value of the variable inside the box

  • outside0The value of the variable outside the box

    Default:0

    C++ Type:double

    Options:

    Description:The value of the variable outside 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