OrientedSubdomainBoundingBoxGenerator

Defines a subdomain inside or outside of a bounding box with arbitrary orientation.

Overview

Example Syntax

[Mesh]
  [./gmg]
    type = GeneratedMeshGenerator
    dim = 3
    xmin = -6
    xmax = 4
    nx = 10
    ymin = -2
    ymax = 10
    ny = 12
    zmin = -5
    zmax = 7
    nz = 12
  []

  [./subdomains]
    type = OrientedSubdomainBoundingBoxGenerator
    input = gmg
    center = '-1 4 1'
    width = 5
    length = 10
    height = 4
    width_direction = '2 1 0'
    length_direction = '-1 2 2'
    block_id = 10
  []
[]
(contrib/moose/test/tests/meshgenerators/subdomain_bounding_box_generator/oriented_subdomain_bounding_box_generator.i)

Input Parameters

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

    C++ Type:unsigned short

    Unit:(no unit assumed)

    Controllable:No

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

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

    C++ Type:libMesh::Point

    Unit:(no unit assumed)

    Controllable:No

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

  • heightThe height of the box

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The height of the box

  • inputThe mesh we want to modify

    C++ Type:MeshGeneratorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The mesh we want to modify

  • lengthThe length of the box

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    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<double>

    Unit:(no unit assumed)

    Controllable:No

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

  • widthThe width of the box

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The width of the box

  • width_directionThe direction along which the width is oriented.

    C++ Type:libMesh::VectorValue<double>

    Unit:(no unit assumed)

    Controllable:No

    Description:The direction along which the width is oriented.

Required Parameters

  • locationINSIDEControl of where the subdomain id is to be set

    Default:INSIDE

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:INSIDE, OUTSIDE

    Controllable:No

    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<std::string>

    Unit:(no unit assumed)

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • save_with_nameKeep the mesh from this mesh generator in memory with the name specified

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Keep the mesh from this mesh generator in memory with the name specified

Advanced Parameters

  • nemesisFalseWhether or not to output the mesh file in the nemesisformat (only if output = true)

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to output the mesh file in the nemesisformat (only if output = true)

  • outputFalseWhether or not to output the mesh file after generating the mesh

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to output the mesh file after generating the mesh

  • show_infoFalseWhether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)

Debugging Parameters