OrientedSubdomainBoundingBoxGenerator

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

Overview

Example Syntax

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  [./gmg]
    type = GeneratedMeshGenerator<<<{"description": "Create a line, square, or cube mesh with uniformly spaced or biased elements.", "href": "GeneratedMeshGenerator.html"}>>>
    dim<<<{"description": "The dimension of the mesh to be generated"}>>> = 3
    xmin<<<{"description": "Lower X Coordinate of the generated mesh"}>>> = -6
    xmax<<<{"description": "Upper X Coordinate of the generated mesh"}>>> = 4
    nx<<<{"description": "Number of elements in the X direction"}>>> = 10
    ymin<<<{"description": "Lower Y Coordinate of the generated mesh"}>>> = -2
    ymax<<<{"description": "Upper Y Coordinate of the generated mesh"}>>> = 10
    ny<<<{"description": "Number of elements in the Y direction"}>>> = 12
    zmin<<<{"description": "Lower Z Coordinate of the generated mesh"}>>> = -5
    zmax<<<{"description": "Upper Z Coordinate of the generated mesh"}>>> = 7
    nz<<<{"description": "Number of elements in the Z direction"}>>> = 12
  []

  [./subdomains]
    type = OrientedSubdomainBoundingBoxGenerator<<<{"description": "Defines a subdomain inside or outside of a bounding box with arbitrary orientation.", "href": "OrientedSubdomainBoundingBoxGenerator.html"}>>>
    input<<<{"description": "The mesh we want to modify"}>>> = gmg
    center<<<{"description": "The center (many people spell this 'center') of the box."}>>> = '-1 4 1'
    width<<<{"description": "The width of the box"}>>> = 5
    length<<<{"description": "The length of the box"}>>> = 10
    height<<<{"description": "The height of the box"}>>> = 4
    width_direction<<<{"description": "The direction along which the width is oriented."}>>> = '2 1 0'
    length_direction<<<{"description": "The direction along which the length is oriented (must be perpendicular to width_direction)."}>>> = '-1 2 2'
    block_id<<<{"description": "Subdomain id to set for inside/outside the bounding box"}>>> = 10
  []
[]
(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

    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

    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

    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

    Options:INSIDE, OUTSIDE

    Controllable:No

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

Optional Parameters

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    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

    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

    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

    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

    Controllable:No

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

Debugging Parameters