- inputsThe input MeshGenerators.
C++ Type:std::vector<MeshGeneratorName>
Unit:(no unit assumed)
Controllable:No
Description:The input MeshGenerators.
- patternA double-indexed hexagonal-shaped array starting with the upper-left corner.
C++ Type:std::vector<std::vector<unsigned int>>
Unit:(no unit assumed)
Controllable:No
Description:A double-indexed hexagonal-shaped array starting with the upper-left corner.
HexIDPatternedMeshGenerator
This mesh generator is deprecated. Please use a PatternedHexMeshGenerator.
Input Parameters
- duct_sizesDistance(s) from center to duct(s) inner boundaries.
C++ Type:std::vector<double>
Unit:(no unit assumed)
Controllable:No
Description:Distance(s) from center to duct(s) inner boundaries.
- duct_sizes_styleapothemStyle in which hexagon center to duct distance(s) is given (apothem = center-to-face, radius = center-to-vertex).
Default:apothem
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Style in which hexagon center to duct distance(s) is given (apothem = center-to-face, radius = center-to-vertex).
- generate_core_metadataFalseA Boolean parameter that controls whether the core related metadata is generated for other MOOSE objects such as 'MultiControlDrumFunction' or not.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:A Boolean parameter that controls whether the core related metadata is generated for other MOOSE objects such as 'MultiControlDrumFunction' or not.
- hexagon_sizeSize of the outmost hexagon boundary to be generated; this is required only when pattern type is 'hexagon'.
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Size of the outmost hexagon boundary to be generated; this is required only when pattern type is 'hexagon'.
- hexagon_size_styleapothemStyle in which the hexagon size is given (default: apothem i.e. half-pitch).
Default:apothem
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Style in which the hexagon size is given (default: apothem i.e. half-pitch).
- interface_boundary_id_shift_patternUser-defined shift values for each pattern cell. A double-indexed array starting with the upper-left corner.
C++ Type:std::vector<std::vector<short>>
Unit:(no unit assumed)
Controllable:No
Description:User-defined shift values for each pattern cell. A double-indexed array starting with the upper-left corner.
- pattern_boundaryhexagonThe boundary shape of the patterned mesh.
Default:hexagon
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The boundary shape of the patterned mesh.
- rotate_angle90Rotate the entire patterned mesh by a certain degrees that is defined here.
Default:90
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Rotate the entire patterned mesh by a certain degrees that is defined here.
Optional Parameters
- assign_control_drum_idTrueWhether control drum id is assigned to the mesh as an extra integer.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether control drum id is assigned to the mesh as an extra integer.
- generate_control_drum_positions_fileFalseWhether a positions file is generated in the core mesh mode.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether a positions file is generated in the core mesh mode.
- position_filepositions_meta.dataData file name to store control drum positions.
Default:positions_meta.data
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Data file name to store control drum positions.
Control Drum Parameters
- assign_typecell List of integer ID assignment types
Default:cell
C++ Type:std::vector<MooseEnum>
Unit:(no unit assumed)
Controllable:No
Description:List of integer ID assignment types
- exclude_idName of input meshes to be excluded in ID generation
C++ Type:std::vector<MeshGeneratorName>
Unit:(no unit assumed)
Controllable:No
Description:Name of input meshes to be excluded in ID generation
- id_nameList of extra integer ID set names
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:List of extra integer ID set names
- id_patternUser-defined element IDs. A double-indexed array starting with the upper-left corner. When providing multiple patterns, each pattern should be separated using '|'
C++ Type:std::vector<std::vector<std::vector<unsigned long, std::allocator<unsigned long>>>>
Unit:(no unit assumed)
Controllable:No
Description:User-defined element IDs. A double-indexed array starting with the upper-left corner. When providing multiple patterns, each pattern should be separated using '|'
Reporting Id Parameters
- background_block_idOptional customized block id for the background block in 'assembly' mode; must be provided along with 'duct_block_ids' if 'duct_sizes' is provided.
C++ Type:unsigned short
Unit:(no unit assumed)
Controllable:No
Description:Optional customized block id for the background block in 'assembly' mode; must be provided along with 'duct_block_ids' if 'duct_sizes' is provided.
- background_block_nameOptional customized block name for the background block in 'assembly' mode; must be provided along with 'duct_block_names' if 'duct_sizes' is provided.
C++ Type:SubdomainName
Unit:(no unit assumed)
Controllable:No
Description:Optional customized block name for the background block in 'assembly' mode; must be provided along with 'duct_block_names' if 'duct_sizes' is provided.
- boundary_region_element_typeQUAD4Type of the quadrilateral elements to be generated in the boundary region.
Default:QUAD4
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Type of the quadrilateral elements to be generated in the boundary region.
- create_inward_interface_boundariesFalseWhether the inward interface boundary sidesets are created.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the inward interface boundary sidesets are created.
- create_outward_interface_boundariesTrueWhether the outward interface boundary sidesets are created.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the outward interface boundary sidesets are created.
- duct_block_idsOptional customized block ids for each duct geometry block in 'assembly' mode; must be provided along with 'background_block_id'.
C++ Type:std::vector<unsigned short>
Unit:(no unit assumed)
Controllable:No
Description:Optional customized block ids for each duct geometry block in 'assembly' mode; must be provided along with 'background_block_id'.
- duct_block_namesOptional customized block names for each duct geometry block in 'assembly' mode; must be provided along with 'background_block_name'.
C++ Type:std::vector<SubdomainName>
Unit:(no unit assumed)
Controllable:No
Description:Optional customized block names for each duct geometry block in 'assembly' mode; must be provided along with 'background_block_name'.
- external_boundary_idOptional customized external boundary id.
C++ Type:short
Unit:(no unit assumed)
Controllable:No
Description:Optional customized external boundary id.
- external_boundary_nameOptional customized external boundary name.
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:Optional customized external boundary name.
Customized Subdomain/Boundary Parameters
- background_intervals3Radial intervals in the assembly peripheral region.
Default:3
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Radial intervals in the assembly peripheral region.
- deform_non_circular_regionTrueWhether the non-circular region (outside the rings) can be deformed.
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the non-circular region (outside the rings) can be deformed.
- duct_intervalsNumber of meshing intervals in each enclosing duct.
C++ Type:std::vector<unsigned int>
Unit:(no unit assumed)
Controllable:No
Description:Number of meshing intervals in each enclosing duct.
- uniform_mesh_on_sidesFalseWhether the side elements are reorganized to have a uniform size.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether the side elements are reorganized to have a uniform size.
Mesh Density Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)