OrientedSubdomainBoundingBox

under construction:Undocumented Class

The OrientedSubdomainBoundingBox has not been documented. The content contained on this page includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /MeshModifiers/OrientedSubdomainBoundingBox

Input Parameters

  • width_directionThe direction along which the width is oriented.

    C++ Type:libMesh::VectorValue

    Options:

    Description:The direction along which the width is oriented.

  • block_idSubdomain id to set for inside/outside the bounding box

    C++ Type:unsigned short

    Options:

    Description:Subdomain id to set for inside/outside the bounding box

  • heightThe height of the box

    C++ Type:double

    Options:

    Description:The height of the box

  • widthThe width of the box

    C++ Type:double

    Options:

    Description:The width of the box

  • lengthThe length of the box

    C++ Type:double

    Options:

    Description:The length of the box

  • length_directionThe direction along which the length is oriented (must be perpendicular to width_direction).

    C++ Type:libMesh::VectorValue

    Options:

    Description:The direction along which the length is oriented (must be perpendicular to width_direction).

  • centerThe center (many people spell this 'center') of the box.

    C++ Type:libMesh::Point

    Options:

    Description:The center (many people spell this 'center') of the box.

Required Parameters

  • force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preperation between modifiers where they might be needed.

    Default:False

    C++ Type:bool

    Options:

    Description:Normally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preperation between modifiers where they might be needed.

  • depends_onThe MeshModifiers that this modifier relies upon (i.e. must execute before this one)

    C++ Type:std::vector

    Options:

    Description:The MeshModifiers that this modifier relies upon (i.e. must execute before this one)

  • locationINSIDEControl of where the subdomain id is to be set

    Default:INSIDE

    C++ Type:MooseEnum

    Options:INSIDE OUTSIDE

    Description:Control of where the subdomain id is to be set

Optional Parameters

  • 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