PatternedHexMeshGenerator

This PatternedHexMeshGenerator source code assembles hexagonal meshes into a hexagonal grid and optionally forces the outer boundary to be hexagonal and/or adds a duct.

Overview

The PatternedHexMeshGenerator object generates a 2D mesh by stitching hexagonal meshes generated by PolygonConcentricCircleMeshGenerator, HexagonConcentricCircleAdaptiveBoundaryMeshGenerator, and itself, based on a user-defined hexagonal grid pattern. The generated 2D mesh can optionally contain an extra background region and/or external duct regions to form a hexagonal external shape rather than a jagged boundary edge.

Geometry Information

In order to generate the hexagonal patterned mesh, three fundamental parameters are needed:

"inputs": a vector of mesh generator names that will be used as elements to form the patterned mesh;
"pattern": a two-dimensional vector that represents the pattern of mesh to be generated. The elements must be integers from 0 to N-1, where N is the length of vector parameter "inputs".
"pattern_boundary": a MooseEnum parameter that can be either hexagon or none. When none is selected, this object only stitches "inputs" meshes into a patterned mesh without extraneous geometry, resulting in an outer boundary with a zig-zag edge. When hexagon is selected, a background region is added so that the generated mesh has a hexagonal shape instead of a zig-zag one. Concentric duct regions may also be optionally added to the hexagon periphery when this parameter is hexagon. The user can refer to Figure 1 for more details.

Figure 1: A schematic showing the difference between none and hexagon pattern_boundary.

When "pattern_boundary" is set as hexagon, the user can also provide "duct_sizes" in either apothem or radius style to add external duct regions to the generated hexagon mesh. Also, "hexagon_size" must also be provided to define the external hexagon boundary size, which can be either apothem or radius of the hexagon, as determined by "hexagon_size_style". In some cases, if "hexagon_size" is small enough, the hexagon external boundary may cut off some of the stitched hexagonal meshes. As long as the concentric circular (rings) regions are not cut off, the rest of the mesh is deformed to accommodate the limited external boundaries.

One of the applications of this object is to generate meshes for prismatic reactor cores. In that case, by setting "generate_core_metadata" as true, control drum meshes can also be used as part of "inputs" to construct the core mesh. To facilitate the use of control drum rotation simulation objects, a series of MeshMetaData can be generated, including:

control_drum_positions: a vector of control drum center positions. This MeshMetaData can also be outputted as an ASCII file by setting "generate_control_drum_positions_file" as true and providing "position_file";
control_drum_angles: a vector of the azimuthal angles of the control drum center positions to the center of the core.
control_drums_azimuthal_meta: a two-dimensional vector containing the sorted azimuthal angles of nodes to the corresponding control drum center for all the control drums.

In addition, "assign_control_drum_id" can be set as true so that the control drum "inputs" meshes can be indexed using an element extra integer called control_drum_id. As illustrated in Figure 2, the control_drum_id is indexed based on the azimuthal angles of the control drums.

Figure 2: A schematic drawing the indexing rule of control_drum_id in the PatternedHexMeshGenerator object.

These MeshMetaData as well as control_drum_id can be used by other MOOSE objects such as MultiControlDrumFunction to simulate control drums rotation during power transients.

Example Syntax

[pattern_1]
  type = PatternedHexMeshGenerator
  inputs = 'hex_1'
  pattern = '0 0;
              0 0 0;
               0 0'
  hexagon_size = 15
  background_block_id = 80
  background_block_name = hex_background
[]

Input Parameters

inputsThe input MeshGenerators.
C++ Type:std::vector<MeshGeneratorName>
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>>
Controllable:No
Description:A double-indexed hexagonal-shaped array starting with the upper-left corner.

Required Parameters

duct_sizesDistance(s) from center to duct(s) inner boundaries.
C++ Type:std::vector<double>
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
Options:apothem, radius
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 or not.
Default:False
C++ Type:bool
Controllable:No
Description:A Boolean parameter that controls whether the core related metadata is generated for other MOOSE objects or not.
hexagon_sizeSize of the outmost hexagon boundary to be generated; this is required only when pattern type is 'hexagon'.
C++ Type:double
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
Options:apothem, radius
Controllable:No
Description:Style in which the hexagon size is given (default: apothem i.e. half-pitch).
pattern_boundaryhexagonThe boundary shape of the patterned mesh.
Default:hexagon
C++ Type:MooseEnum
Options:none, hexagon
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
Controllable:No
Description:Rotate the entire patterned mesh by a certain degrees that is defined here.
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)

Optional Parameters

assign_control_drum_idTrueWhether control drum id is assigned to the mesh as an extra integer.
Default:True
C++ Type:bool
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
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
Controllable:No
Description:Data file name to store control drum positions.

Control Drum 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
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
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.
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>
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>
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
Controllable:No
Description:Optional customized external boundary id.
external_boundary_nameOptional customized external boundary name.
C++ Type:std::string
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
Controllable:No
Description:Radial intervals in the assembly peripheral region.
duct_intervalsNumber of meshing intervals in each enclosing duct.
C++ Type:std::vector<unsigned int>
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
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>
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.

Advanced Parameters

Input Files

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_err.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern.i)
(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd_noid.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err2.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_cd.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/single_hex.i)
(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_block_name_conflict.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/patterned.i)

Child Objects

(modules/reactor/include/meshgenerators/HexIDPatternedMeshGenerator.h)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
    hexagon_size = 15
    background_block_id = 80
    background_block_name = hex_background
  []
  [pattern_2]
    type = PatternedHexMeshGenerator
    inputs = 'pattern_1'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0 0;
              0 0 0 0;
             0 0 0 0 0;
              0 0 0 0;
               0 0 0'
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_err.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [hex_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 3.0
    ring_intervals = 2
    ring_block_ids = '20 25'
    ring_block_names = 'center_tri center'
    background_block_ids = 40
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1 hex_2'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0;
              0 0 0;
               0 0'

  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
    hexagon_size = 15
    background_block_id = 80
    background_block_name = hex_background
  []
  [pattern_2]
    type = PatternedHexMeshGenerator
    inputs = 'pattern_1'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0 0;
              0 0 0 0;
             0 0 0 0 0;
              0 0 0 0;
               0 0 0'
  []
[]

(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd_noid.i)

[Problem]
  solve = false
[]

[Mesh]
  [hex_unit]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6 # must be six to use hex pattern
    num_sectors_per_side= '2 2 2 2 2 2'
    background_intervals=1
    polygon_size = 1

    ring_radii = '0.9'
    ring_intervals = '1'
  []
  [patterned]
    type = PatternedHexMeshGenerator
    inputs = 'hex_unit'
    pattern_boundary = hexagon
    background_intervals = 1
    hexagon_size = 3.5

    pattern = '0 0;
              0 0 0;
               0 0'
  []
  [cd_1]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '4'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_2]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '5'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_3]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '0'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_4]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '1'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_5]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '2'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_6]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '3'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [core]
    type = PatternedHexMeshGenerator
    inputs = 'patterned cd_1 cd_2 cd_3 cd_4 cd_5 cd_6'
    #             0       1    2    3    4    5    6
    pattern_boundary = none
    generate_core_metadata = true
    generate_control_drum_positions_file = true
    pattern = '1 6;
              2 0 5;
               3 4'
  []
[]

[AuxVariables]
  [cd_param]
    family = MONOMIAL
    order = CONSTANT
    block = 5002
  []
  [cd_id]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [cd_param_assign]
    type = FunctionAux
    variable = cd_param
    function = cd_param_func
    execute_on = 'initial linear timestep_end'
  []
  [set_cd_id]
    type = ExtraElementIDAux
    variable = cd_id
    extra_id_name = control_drum_id
    execute_on = 'initial timestep_end'
  []
[]

[Functions]
  [cd_param_func]
    type = MultiControlDrumFunction
    mesh_generator = core
    use_control_drum_id = false
    angular_speeds = '5 10 15 20 25 30'
    start_angles = '0 0 0 0 0 0'
    angle_ranges = '90 90 90 90 90 90'
  []
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 5
[]

[Outputs]
  [nocdid]
    type = Exodus
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err2.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
    hexagon_size = 15
    background_block_id = 80
    background_block_name = hex_background
  []
  [pattern_2]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
    hexagon_size = 16
    background_block_id = 80
    background_block_name = hex_background
  []
  [pattern_3]
    type = PatternedHexMeshGenerator
    inputs = 'pattern_1 pattern_2'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0;
              0 1 0;
               0 0'
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_cd.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0 0;
              0 0 0 0;
             0 0 0 0 0;
              0 0 0 0;
               0 0 0'
    hexagon_size = 25
    background_block_id = 80
    background_block_name = hex_background
  []
  [cd_1]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    hexagon_size = 25
    sides_to_adapt = '0 1 5'
    inputs = 'pattern_1 pattern_1 pattern_1'
    is_control_drum = true
  []
  [pattern_2]
    type = PatternedHexMeshGenerator
    inputs = 'pattern_1 cd_1'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0 ;
              0 0 0;
               1 0'
    generate_control_drum_positions_file = true
    assign_control_drum_id = true
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/single_hex.i)

[Mesh]
  [hex]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '2 2 2 2 2 2'
    background_intervals = 1
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern]
    type = PatternedHexMeshGenerator
    inputs = 'hex'
    pattern = '0 0;
              0 0 0;
               0 0'
    background_intervals = 2
    hexagon_size = 17
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg]
    type = PatternedHexPeripheralModifier
    input = pattern
    input_mesh_external_boundary = 10000
    new_num_sector = 10
    num_layers = 2
  []
[]

(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd.i)

[Problem]
  solve = false
[]

[Mesh]
  [hex_unit]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6 # must be six to use hex pattern
    num_sectors_per_side= '2 2 2 2 2 2'
    background_intervals=1
    polygon_size = 1

    ring_radii = '0.9'
    ring_intervals = '1'
  []
  [patterned]
    type = PatternedHexMeshGenerator
    inputs = 'hex_unit'
    pattern_boundary = hexagon
    background_intervals = 1
    hexagon_size = 3.5

    pattern = '0 0;
              0 0 0;
               0 0'
  []
  [cd_1]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '4'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_2]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '5'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_3]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '0'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_4]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '1'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_5]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '2'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [cd_6]
    type = HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
    inputs = 'patterned'
    sides_to_adapt = '3'

    num_sectors_per_side= '2 2 2 2 2 2'
    hexagon_size = 3.5
    background_intervals= 1

    ring_radii = '2 3'
    ring_intervals = '1 1'

    block_id_shift = 5000
    is_control_drum = true
  []
  [core]
    type = PatternedHexMeshGenerator
    inputs = 'patterned cd_1 cd_2 cd_3 cd_4 cd_5 cd_6'
    #             0       1    2    3    4    5    6
    pattern_boundary = none
    generate_core_metadata = true
    generate_control_drum_positions_file = true
    pattern = '1 6;
              2 0 5;
               3 4'
  []
[]

[AuxVariables]
  [cd_param]
    family = MONOMIAL
    order = CONSTANT
    block = 5002
  []
  [cd_id]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [cd_param_assign]
    type = FunctionAux
    variable = cd_param
    function = cd_param_func
    execute_on = 'initial linear timestep_end'
  []
  [set_cd_id]
    type = ExtraElementIDAux
    variable = cd_id
    extra_id_name = control_drum_id
    execute_on = 'initial timestep_end'
  []
[]

[Functions]
  [cd_param_func]
    type = MultiControlDrumFunction
    mesh_generator = core
    angular_speeds = '2 4 8 16 64 128'
    start_angles = '0 0 0 0 0 0'
    angle_ranges = '90 90 90 90 90 90'
  []
[]

[Executioner]
  type = Transient
  dt = 1
  num_steps = 5
[]

[Outputs]
  [default]
    type = Exodus
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_block_name_conflict.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [hex_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 30
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1 hex_2'
    pattern_boundary = none
    pattern = '0 0;
              0 1 0;
               0 0'
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err.i)

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '4 4 4 4 4 4'
    background_intervals = 2
    ring_radii = 4.0
    ring_intervals = 2
    ring_block_ids = '10 15'
    ring_block_names = 'center_tri center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0;
              0 0 0;
               0 0'

  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/patterned.i)

new_num_sector = 10
num_layer = 2

[Mesh]
  [hex_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '2 2 2 2 2 2'
    background_intervals = 1
    ring_radii = 4.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_1'
    background_block_ids = 20
    background_block_names = background_1
    polygon_size = 5.0
    preserve_volumes = on
    quad_center_elements = true
  []
  [pattern_1]
    type = PatternedHexMeshGenerator
    inputs = 'hex_1'
    pattern = '0 0;
              0 0 0;
               0 0'
    background_intervals = 1
    hexagon_size = 17
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg_1]
    type = PatternedHexPeripheralModifier
    input = pattern_1
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [hex_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '2 2 2 2 2 2'
    background_intervals = 1
    ring_radii = 2.5
    ring_intervals = 1
    ring_block_ids = '30'
    ring_block_names = 'center_2'
    background_block_ids = 40
    background_block_names = background_2
    polygon_size = 3.0
    preserve_volumes = on
    quad_center_elements = true
  []
  [pattern_2]
    type = PatternedHexMeshGenerator
    inputs = 'hex_2'
    pattern = '0 0 0;
              0 0 0 0;
             0 0 0 0 0;
              0 0 0 0;
               0 0 0'
    background_intervals = 1
    hexagon_size = 17
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg_2]
    type = PatternedHexPeripheralModifier
    input = pattern_2
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [hex_3]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '2 2 2 2 2 2'
    background_intervals = 1
    ring_radii = 1.5
    ring_intervals = 1
    ring_block_ids = '50'
    ring_block_names = 'center_3'
    background_block_ids = 60
    background_block_names = background_3
    polygon_size = 2.3
    preserve_volumes = on
    quad_center_elements = true
  []
  [pattern_3]
    type = PatternedHexMeshGenerator
    inputs = 'hex_3'
    pattern = '0 0 0 0;
              0 0 0 0 0;
             0 0 0 0 0 0;
            0 0 0 0 0 0 0;
             0 0 0 0 0 0;
              0 0 0 0 0;
               0 0 0 0'
    background_intervals = 1
    hexagon_size = 17
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg_3]
    type = PatternedHexPeripheralModifier
    input = pattern_3
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [hex_4]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 6
    num_sectors_per_side = '2 2 2 2 2 2'
    background_intervals = 1
    ring_radii = 1.4
    ring_intervals = 1
    ring_block_ids = '70'
    ring_block_names = 'center_4'
    background_block_ids = 80
    background_block_names = background_4
    polygon_size = 1.8
    preserve_volumes = on
    quad_center_elements = true
  []
  [pattern_4]
    type = PatternedHexMeshGenerator
    inputs = 'hex_4'
    pattern = '0 0 0 0 0;
              0 0 0 0 0 0;
             0 0 0 0 0 0 0;
            0 0 0 0 0 0 0 0;
           0 0 0 0 0 0 0 0 0;
            0 0 0 0 0 0 0 0;
             0 0 0 0 0 0 0;
              0 0 0 0 0 0;
               0 0 0 0 0'
    background_intervals = 1
    hexagon_size = 17
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg_4]
    type = PatternedHexPeripheralModifier
    input = pattern_4
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [pattern_sum]
    type = PatternedHexMeshGenerator
    inputs = 'pmg_1 pmg_2 pmg_3 pmg_4'
    pattern = '2 3;
              1 0 1;
               3 2'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

(modules/reactor/include/meshgenerators/HexIDPatternedMeshGenerator.h)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "PatternedHexMeshGenerator.h"
#include "MooseEnum.h"
#include "MeshMetaDataInterface.h"

/**
 * Generates patterned hexagonal meshes with a reporting ID
 */
class HexIDPatternedMeshGenerator : public PatternedHexMeshGenerator
{
public:
  static InputParameters validParams();

  HexIDPatternedMeshGenerator(const InputParameters & parameters);

  std::unique_ptr<MeshBase> generate() override;

protected:
  /// name of integer ID
  const std::string _element_id_name;
  /// integer ID assignment type
  const std::string _assign_type;
  /// flag to indicate if exclude_id is defined
  const bool _use_exclude_id;
  /// flag to indicate if exclude_id is used for each input
  std::vector<bool> _exclude_ids;
  /// hold integer ID for each input pattern cell
  std::vector<std::vector<dof_id_type>> _id_pattern;
};

Overview
Geometry Information
Control Drum Related MeshMetaData
Example Syntax
Input Parameters
Input Files
Child Objects

Install MOOSE

New Users

Examples and Tutorials

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools

INL Applications and Remote Access

PatternedHexMeshGenerator

Overview

Geometry Information

Example Syntax

Input Parameters

Required Parameters

Optional Parameters

Control Drum Parameters

Customized Subdomain/Boundary Parameters

Mesh Density Parameters

Advanced Parameters

Input Files

Child Objects

PatternedHexMeshGenerator

Overview

Geometry Information

Control Drum Related MeshMetaData

Example Syntax

Input Parameters

Required Parameters

Optional Parameters

Control Drum Parameters

Customized Subdomain/Boundary Parameters

Mesh Density Parameters

Advanced Parameters

Input Files

Child Objects

inputs

pattern

inputs

pattern_boundary

inputs

pattern_boundary

duct_sizes

hexagon_size

hexagon_size_style

hexagon_size

generate_core_metadata

inputs

generate_control_drum_positions_file

position_file

assign_control_drum_id

inputs

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_err.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern.i)

(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd_noid.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err2.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_cd.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/single_hex.i)

(modules/reactor/test/tests/functions/multi_control_drum_function/multi_cd.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_2d_block_name_conflict.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_mesh_generator/patterned_pattern_err.i)

(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/patterned.i)

(modules/reactor/include/meshgenerators/HexIDPatternedMeshGenerator.h)