OrientedSubdomainBoundingBox

under construction:Undocumented Class

The OrientedSubdomainBoundingBox has not been documented. The content listed below should be used as a starting point for documenting the class, which 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.


# OrientedSubdomainBoundingBox

!syntax description /MeshModifiers/OrientedSubdomainBoundingBox

## Overview

!! Replace these lines with information regarding the OrientedSubdomainBoundingBox object.

## Example Input File Syntax

!! Describe and include an example of how to use the OrientedSubdomainBoundingBox object.

!syntax parameters /MeshModifiers/OrientedSubdomainBoundingBox

!syntax inputs /MeshModifiers/OrientedSubdomainBoundingBox

!syntax children /MeshModifiers/OrientedSubdomainBoundingBox

!syntax description /MeshModifiers/OrientedSubdomainBoundingBox

Input Parameters

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
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.
heightThe height of the box
C++ Type:double
Options:
Description:The height 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).
widthThe width of the box
C++ Type:double
Options:
Description:The width of the box
width_directionThe direction along which the width is oriented.
C++ Type:libMesh::VectorValue
Options:
Description:The direction along which the width is oriented.

Required Parameters

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)
force_prepareFalseNormally all MeshModifiers run before the mesh is prepared for use. This flag can be set on an individual modifier to force preparation 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 preparation between modifiers where they might be needed.
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

test/tests/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box_outside.i
test/tests/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box.i
test/tests/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box_inside.i
test/tests/mesh_modifiers/block_deleter/BlockDeleterTest11.i

test/tests/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box_outside.i

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

[MeshModifiers]
  [./subdomains]
    type = OrientedSubdomainBoundingBox
    center = '-1 4 1'
    width = 5
    length = 10
    height = 4
    width_direction = '2 1 0'
    length_direction = '-1 2 2'
    block_id = 10
    location = OUTSIDE
  [../]
[]

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

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

[Materials]
  [./mat10]
    type = GenericConstantMaterial
    block = 10
    outputs = all
    prop_values = 6.24
    prop_names = prop
  [../]
  [./mat0]
    type = GenericConstantMaterial
    block = 0
    prop_names = prop
    prop_values = 0
  [../]
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
[]

[Outputs]
  exodus = true
[]

test/tests/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box.i

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

[MeshModifiers]
  [./subdomains]
    type = OrientedSubdomainBoundingBox
    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/mesh_modifiers/subdomain_bounding_box/oriented_subdomain_bounding_box_inside.i

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

[MeshModifiers]
  [./subdomains]
    type = OrientedSubdomainBoundingBox
    center = '-1 4 1'
    width = 5
    length = 10
    height = 4
    width_direction = '2 1 0'
    length_direction = '-1 2 2'
    block_id = 10
    location = INSIDE
  [../]
[]

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

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

[Materials]
  [./mat10]
    type = GenericConstantMaterial
    block = 10
    outputs = all
    prop_values = 6.24
    prop_names = prop
  [../]
  [./mat0]
    type = GenericConstantMaterial
    block = 0
    prop_names = prop
    prop_values = 0
  [../]
[]

[Executioner]
  type = Steady
  solve_type = PJFNK
[]

[Outputs]
  exodus = true
[]

test/tests/mesh_modifiers/block_deleter/BlockDeleterTest11.i

# tet elements
[Mesh]
  type = FileMesh
  file = pyramid.e
[]

[MeshModifiers]
  [./sbb2]
    type = SubdomainBoundingBox
    block_id = 2
    bottom_left = '-0.5 -0.5 -0.5'
    top_right = '0.5 0.5 0.5'
  [../]
  [./swiss_cheese2]
    type = BlockDeleter
    block_id = 2
    depends_on = 'sbb2'
  [../]
  [./sbb3]
    type = SubdomainBoundingBox
    block_id = 3
    bottom_left = '-5 -5 -3'
    top_right = '-2 -2 -1'
  [../]
  [./swiss_cheese3]
    type = BlockDeleter
    block_id = 3
    depends_on = 'sbb3'
  [../]
  [./sbb4]
    type = SubdomainBoundingBox
    block_id = 4
    bottom_left = '-1 2 -2'
    top_right = '1 5 0'
  [../]
  [./swiss_cheese4]
    type = BlockDeleter
    block_id = 4
    depends_on = 'sbb4'
  [../]
  [./sbb5]
    type = OrientedSubdomainBoundingBox
    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 = BlockDeleter
    block_id = 5
    depends_on = 'sbb5'
  [../]
  [./sbb6]
    type = OrientedSubdomainBoundingBox
    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 = BlockDeleter
    block_id = 6
    depends_on = '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
[]

Input Parameters
Input Files

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools