- dimThe dimension of the mesh to be generated
C++ Type:MooseEnum
Controllable:No
Description:The dimension of the mesh to be generated
- inputThe base mesh we want to overlay
C++ Type:MeshGeneratorName
Controllable:No
Description:The base mesh we want to overlay
OverlayMeshGenerator
Creates a Cartesian mesh overlaying the input mesh region.
Overview
The OverlayMeshGenerator object is the built-in mesh generation capable of creating a Cartesian mesh overlaying the given input mesh. The overlay mesh uses DistributedRectilinearMeshGenerator as sub-generator. The input parameters for DistributedRectilinearMeshGenerator are all available for OverlayMeshGenerator. The required input parameters are "dim" (the dimension of the domain) and "input" (the base mesh we want to overlay).
Example Syntax
[Mesh]
[gmg]
type = GeneratedMeshGenerator
dim = 2
nx = 3
ny = 3
xmin = -1
xmax = 4
ymin = -1
ymax = 2.2
output = true
[]
[bcg]
type = OverlayMeshGenerator
input = 'gmg'
dim = 2
nx = 6
ny = 6
[]
[]
Input Parameters
- apply_element_weightFalseIndicate if we are going to apply element weights to partitioners
Default:False
C++ Type:bool
Controllable:No
Description:Indicate if we are going to apply element weights to partitioners
- apply_side_weightFalseIndicate if we are going to apply side weights to partitioners
Default:False
C++ Type:bool
Controllable:No
Description:Indicate if we are going to apply side weights to partitioners
- bias_x1The amount by which to grow (or shrink) the cells in the x-direction.
Default:1
C++ Type:double
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
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
Controllable:No
Description:The amount by which to grow (or shrink) the cells in the z-direction.
- elem_typeThe type of element from libMesh to generate (default: linear element for requested dimension)
C++ Type:MooseEnum
Controllable:No
Description:The type of element from libMesh to generate (default: linear element for requested dimension)
- num_cores_for_partition0Number of cores for partitioning the graph
Default:0
C++ Type:unsigned int
Controllable:No
Description:Number of cores for partitioning the graph
- num_cores_per_compute_node1Number of cores per compute node for hierarchical partitioning
Default:1
C++ Type:unsigned int
Controllable:No
Description:Number of cores per compute node for hierarchical partitioning
- num_side_layers2Number of layers of off-processor side neighbors is reserved during mesh generation
Default:2
C++ Type:unsigned int
Controllable:No
Description:Number of layers of off-processor side neighbors is reserved during mesh generation
- nx1Number of elements in the X direction
Default:1
C++ Type:unsigned long
Controllable:No
Description:Number of elements in the X direction
- ny1Number of elements in the Y direction
Default:1
C++ Type:unsigned long
Controllable:No
Description:Number of elements in the Y direction
- nz1Number of elements in the Z direction
Default:1
C++ Type:unsigned long
Controllable:No
Description:Number of elements in the Z direction
- part_packageparmetisThe external package is used for partitioning the mesh via PETSc
Default:parmetis
C++ Type:MooseEnum
Controllable:No
Description:The external package is used for partitioning the mesh via PETSc
- partitiongraphWhich method (graph linear square) use to partition mesh
Default:graph
C++ Type:MooseEnum
Controllable:No
Description:Which method (graph linear square) use to partition mesh
- xmax1Upper X Coordinate of the generated mesh
Default:1
C++ Type:double
Controllable:No
Description:Upper X Coordinate of the generated mesh
- xmin0Lower X Coordinate of the generated mesh
Default:0
C++ Type:double
Controllable:No
Description:Lower X Coordinate of the generated mesh
- ymax1Upper Y Coordinate of the generated mesh
Default:1
C++ Type:double
Controllable:No
Description:Upper Y Coordinate of the generated mesh
- ymin0Lower Y Coordinate of the generated mesh
Default:0
C++ Type:double
Controllable:No
Description:Lower Y Coordinate of the generated mesh
- zmax1Upper Z Coordinate of the generated mesh
Default:1
C++ Type:double
Controllable:No
Description:Upper Z Coordinate of the generated mesh
- zmin0Lower Z Coordinate of the generated mesh
Default:0
C++ Type:double
Controllable:No
Description:Lower Z Coordinate of the generated mesh
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
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
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)