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
  []
[]

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

Input Files

(test/tests/meshgenerators/subdomain_bounding_box_generator/oriented_subdomain_bounding_box_generator.i)
(test/tests/meshgenerators/block_deletion_generator/block_deletion_test11.i)

(test/tests/meshgenerators/subdomain_bounding_box_generator/oriented_subdomain_bounding_box_generator.i)

[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
  []
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Variables]
  [./u]
  [../]
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
[]

[Outputs]
  exodus = true
[]

(test/tests/meshgenerators/subdomain_bounding_box_generator/oriented_subdomain_bounding_box_generator.i)

[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
  []
[]

[Problem]
  type = FEProblem
  solve = false
  kernel_coverage_check = false
[]

[Variables]
  [./u]
  [../]
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
[]

[Outputs]
  exodus = true
[]

(test/tests/meshgenerators/block_deletion_generator/block_deletion_test11.i)

[Mesh]
  [fmg]
    type = FileMeshGenerator
    file = pyramid.e
  []

  [sbb2]
    type = SubdomainBoundingBoxGenerator
    input = fmg
    block_id = 2
    bottom_left = '-0.5 -0.5 -0.5'
    top_right = '0.5 0.5 0.5'
  []
  [swiss_cheese2]
    type = BlockDeletionGenerator
    block = 2
    input = 'sbb2'
  []
  [sbb3]
    type = SubdomainBoundingBoxGenerator
    input = swiss_cheese2
    block_id = 3
    bottom_left = '-5 -5 -3'
    top_right = '-2 -2 -1'
  []
  [swiss_cheese3]
    type = BlockDeletionGenerator
    block = 3
    input = 'sbb3'
  []
  [sbb4]
    type = SubdomainBoundingBoxGenerator
    input = swiss_cheese3
    block_id = 4
    bottom_left = '-1 2 -2'
    top_right = '1 5 0'
  []
  [swiss_cheese4]
    type = BlockDeletionGenerator
    block = 4
    input = 'sbb4'
  []
  [sbb5]
    type = OrientedSubdomainBoundingBoxGenerator
    input = swiss_cheese4
    block_id = 5
    center = '2.4 -1.4 0.4'
    height = 3
    length = 8
    length_direction = '-2 1 -1'
    width = 3
    width_direction = '1 2 0'
  []
  [swiss_cheese5]
    type = BlockDeletionGenerator
    block = 5
    input = 'sbb5'
  []
  [sbb6]
    type = OrientedSubdomainBoundingBoxGenerator
    input = swiss_cheese5
    block_id = 6
    center = '-1 0.4 2.2'
    height = 1
    length = 8
    length_direction = '2 -1 -1'
    width = 1
    width_direction = '1 2 0'
  []
  [swiss_cheese6]
    type = BlockDeletionGenerator
    block = 6
    input = 'sbb6'
  []
[]

[Variables]
  [u]
  []
[]

[Kernels]
  [dt]
    type = TimeDerivative
    variable = u
  []
  [diff]
    type = Diffusion
    variable = u
  []
[]

[BCs]
  [top]
    type = DirichletBC
    variable = u
    boundary = top
    value = 1
  []
[]

[Executioner]
  type = Transient
  start_time = 0
  end_time = 100
  dt = 100

  solve_type = NEWTON

  petsc_options_iname = '-pc_type -pc_hypre_type'
  petsc_options_value = 'hypre boomeramg'
[]

[Outputs]
  exodus = true
[]

Overview
Example Syntax
Input Parameters
Input Files