DomainMeshGenerator

Create a line, square, or cube mesh with uniformly spaced or biased elements.

This object should not be used directly, but instead be added through the Domain action.

Example Input File Syntax

[Domain<<<{"href": "../../syntax/Domain/index.html"}>>>]
  dim<<<{"description": "Problem dimension"}>>> = 2
  nx<<<{"description": "Number of elements in the X direction"}>>> = 10
  ny<<<{"description": "Number of elements in the Y direction"}>>> = 10
  mesh_mode<<<{"description": "Mesh generation mode."}>>> = DUMMY
  parallel_mode<<<{"description": "Parallelization mode."}>>> = REAL_SPACE
  periodic_directions<<<{"description": "Periodic directions of the simulation cell (controls halo exchange wrap-around)."}>>> = 'X Y'
[]

Input Parameters

dimThe dimension of the mesh to be generated
C++ Type:MooseEnum
Options:1, 2, 3
Controllable:No
Description:The dimension of the mesh to be generated

Required Parameters

bias_x1The amount by which to grow (or shrink) the cells in the x-direction.
Default:1
C++ Type:double
Unit:(no unit assumed)
Range:bias_x>=0.5 & bias_x<=2
Controllable:No
Description:The amount by which to grow (or shrink) the cells in the x-direction.
bias_y1The amount by which to grow (or shrink) the cells in the y-direction.
Default:1
C++ Type:double
Unit:(no unit assumed)
Range:bias_y>=0.5 & bias_y<=2
Controllable:No
Description:The amount by which to grow (or shrink) the cells in the y-direction.
bias_z1The amount by which to grow (or shrink) the cells in the z-direction.
Default:1
C++ Type:double
Unit:(no unit assumed)
Range:bias_z>=0.5 & bias_z<=2
Controllable:No
Description:The amount by which to grow (or shrink) the cells in the z-direction.
boundary_id_offset0This offset is added to the generated boundary IDs
Default:0
C++ Type:short
Controllable:No
Description:This offset is added to the generated boundary IDs
boundary_name_prefixIf provided, prefix the built in boundary names with this string
C++ Type:std::string
Controllable:No
Description:If provided, prefix the built in boundary names with this string
elem_typeThe type of element from libMesh to generate (default: linear element for requested dimension)
C++ Type:MooseEnum
Options:EDGE, EDGE2, EDGE3, EDGE4, QUAD, QUAD4, QUAD8, QUAD9, TRI, TRI3, TRI6, TRI7, HEX, HEX8, HEX20, HEX27, TET, TET4, TET10, TET14, PRISM, PRISM6, PRISM15, PRISM18, PYRAMID, PYRAMID5, PYRAMID13, PYRAMID14, C0POLYGON, C0POLYHEDRON
Controllable:No
Description:The type of element from libMesh to generate (default: linear element for requested dimension)
extra_element_integersNames of extra element integers
C++ Type:std::vector<ExtraElementIDName>
Controllable:No
Description:Names of extra element integers
gauss_lobatto_gridFalseGrade mesh into boundaries according to Gauss-Lobatto quadrature spacing.
Default:False
C++ Type:bool
Controllable:No
Description:Grade mesh into boundaries according to Gauss-Lobatto quadrature spacing.
nx1Number of elements in the X direction
Default:1
C++ Type:unsigned int
Controllable:No
Description:Number of elements in the X direction
ny1Number of elements in the Y direction
Default:1
C++ Type:unsigned int
Controllable:No
Description:Number of elements in the Y direction
nz1Number of elements in the Z direction
Default:1
C++ Type:unsigned int
Controllable:No
Description:Number of elements in the Z direction
subdomain_idsSubdomain IDs for each element, default to all zero. If a single number is specified, that subdomain id is used for all elements.
C++ Type:std::vector<unsigned short>
Controllable:No
Description:Subdomain IDs for each element, default to all zero. If a single number is specified, that subdomain id is used for all elements.
subdomain_nameIf specified, single subdomain name for all elements
C++ Type:SubdomainName
Controllable:No
Description:If specified, single subdomain name for all elements
xmax1Upper X Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper X Coordinate of the generated mesh
xmin0Lower X Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower X Coordinate of the generated mesh
ymax1Upper Y Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper Y Coordinate of the generated mesh
ymin0Lower Y Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower Y Coordinate of the generated mesh
zmax1Upper Z Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper Z Coordinate of the generated mesh
zmin0Lower Z Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower Z Coordinate of the generated mesh

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

(test/tests/lbm/channel2D.i)

[Domain]
  dim = 2
  nx = 10
  ny = 10
  mesh_mode = DUMMY
  parallel_mode = REAL_SPACE
  periodic_directions = 'X Y'
[]

[Stencil]
  [d2q9]
    type = LBMD2Q9
  []
[]

[TensorBuffers]
  [f]
    type = LBMTensorBuffer
    buffer_type = df
  []
  [feq]
    type = LBMTensorBuffer
    buffer_type = df
  []
  [fpc]
    type = LBMTensorBuffer
    buffer_type = df
  []
  [velocity]
    type=LBMTensorBuffer
    buffer_type = mv
  []
  [density]
    type=LBMTensorBuffer
    buffer_type = ms
  []
  [speed]
    type=LBMTensorBuffer
    buffer_type = ms
  []
[]

[TensorComputes]
  [Initialize]
    [initial_density]
      type = LBMConstantTensor
      buffer = density
      constants = 1.0
    []
    [initial_velocity]
      type = LBMConstantTensor
      buffer = velocity
      constants = '0.0 0.0'
    []
    [initial_equilibrium]
      type = LBMEquilibrium
      buffer = feq
      bulk = density
      velocity = velocity
    []
    [initial_distribution]
      type = LBMEquilibrium
      buffer = f
      bulk = density
      velocity = velocity
    []
    [initial_distribution_pc]
      type = LBMEquilibrium
      buffer = fpc
      bulk = density
      velocity = velocity
    []
  []
  [Solve]
    [equilibrium]
      type=LBMEquilibrium
      buffer = feq
      bulk = density
      velocity = velocity
    []
    [collision]
      type=LBMBGKCollision
      buffer = fpc
      f = f
      feq = feq
      tau0 = 1.0
    []
    [density]
      type = LBMComputeDensity
      buffer = density
      f = f
    []
    [velocity]
      type = LBMComputeVelocity
      buffer = velocity
      f = f
      rho = density
      add_body_force = true
      body_force_x = 0.0001
    []
    [speed]
      type = LBMComputeVelocityMagnitude
      buffer = speed
      velocity = velocity
    []
    [residual]
      type = LBMComputeResidual
      buffer = speed
      speed = speed
    []
  []
  [Boundary]
    [top]
      type = LBMBounceBack
      buffer = f
      f_old = fpc
      boundary = top
    []
    [bottom]
      type = LBMBounceBack
      buffer = f
      f_old = fpc
      boundary = bottom
    []
  []
[]

[TensorSolver]
  type = LBMStream
  buffer = f
  f_old = fpc
[]

[Problem]
  type = LatticeBoltzmannProblem
  substeps = 10
[]

[Postprocessors]
  [velocity_min]
    type = TensorExtremeValuePostprocessor
    buffer = velocity
    value_type = MIN
  []
  [velocity_max]
    type = TensorExtremeValuePostprocessor
    buffer = velocity
    value_type = MAX
  []
  [speed_min]
    type = TensorExtremeValuePostprocessor
    buffer = speed
    value_type = MIN
  []
  [speed_max]
    type = TensorExtremeValuePostprocessor
    buffer = speed
    value_type = MAX
  []
  [density_min]
    type = TensorExtremeValuePostprocessor
    buffer = density
    value_type = MIN
  []
  [densty_max]
    type = TensorExtremeValuePostprocessor
    buffer = density
    value_type = MAX
  []
[]

[Executioner]
  type = Transient
  num_steps = 11
[]

[Outputs]
  file_base = channel2D
  csv = true
[]

Example Input File Syntax
Input Parameters