PatternedCartesianMeshGenerator

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

Overview

The PatternedCartesianMeshGenerator object generates a 2D mesh by stitching cartesian (square-shaped) meshes generated by PolygonConcentricCircleMeshGenerator, CartesianConcentricCircleAdaptiveBoundaryMeshGenerator, and itself, based on a user-defined square grid pattern. The generated 2D mesh can optionally contain an extra background region and/or external duct regions to form an expanded square external shape rather than a purely stacked square of squares.

Geometry Information

In order to generate the square 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 none or expanded. When none is selected, this object only stitches "inputs" meshes into a patterned mesh without extraneous geometry, resulting in a simply stacked square of unit squares. When expanded is selected, a background region is added so that the generated mesh has an expanded square shape instead of a simply stacked one. Concentric duct regions may also be optionally added to the square periphery when this parameter is expanded. The user can refer to Figure 1 for more details.

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

When "pattern_boundary" is set as expanded, the user can also provide "duct_sizes" in either apothem (center-to-face) or radius (center-to-vertex) style determined by "duct_sizes_style" to add external duct regions to the generated square mesh. Also, "square_size" must also be provided to define the external square boundary size. In some cases, if "square_size" is small enough, the square external boundary may cut off some of the stitched square 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. Users can also set "deform_non_circular_region" as false to prevent the non-circular regions from being deformed.

One of the applications of this object is to generate meshes for reactor cores with control drums. 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 PatternedCartesianMeshGenerator 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.

Interface Boundaries

The user can also decide whether the interface boundaries are generated or not in the peripheral region.

There are two types of interface boundaries, "inward interface boundaries" and "outward interface boundaries". The "inward" and "outward" here refer to the direction of the boundary's normal vector. As a sideset must be defined on the sides of elements, which belong to one or multiple subdomains, an interface boundary can be defined either on the subdomain immediately inside the interface (i.e., with an "outward" normal vector) or on the subdomain immediately outside the interface (i.e., with an "inward" normal vector).

The user can set "create_inward_interface_boundaries" and "create_outward_interface_boundaries" to control which interface boundaries will be created. If generated, the outward interface boundaries will be assigned ids using sequential odd numbers (i.e., 1, 3, 5, 7, ...) shifted by INTRINSIC_SIDESET_ID::SLICE_ALT=30500 from center to periphery, while the inward interface boundaries will be assigned ids using sequential even numbers (i.e., 0, 2, 4, 6, ...) shifted by INTRINSIC_SIDESET_ID::SLICE_ALT similarly.

Reporting ID Information

This object can generate a Cartesian lattice mesh with reporting ID assignments. It can be used successively on another PatternedCartesianMeshGenerator output mesh to add IDs on the pin and assembly levels, for example. The reporting ID option can be turned on by defining the name of the reporting ID variable is provided through "id_name".

Reporting IDs are assigned to all elements in each tile of the pattern following a per-tile assignment strategy. A user can select an ID assignment scheme using "assign_type", and the following schemes are currently available:

cell (default): Assign unique IDs for each component/tile in the lattice in sequential order.
pattern: Assign IDs based on the ID of the input tiles.
manual: Assign IDs based on user-defined mapping defined in "id_pattern".

The default numbering scheme starts at 0 in the upper left hand corner of Cartesian grid (not including duct region) and increments by 1 as the grid is traversed left to right, top to bottom In presence of duct regions, separate reporting IDs are automatically generated for the elements in duct regions. For the pattern scheme, all tiles in the pattern with the same input will bear the same reporting ID. The duct regions will be assigned reporting IDs starting from the next integer higher than the highest one used inside of the ducts.

The name of the reporting ID variable is provided through "id_name" depending on the hierarchical level of component. The ID values themselves are stored as extra element integers on the mesh. For example, the reporting IDs for individual pins (pin_id) can be assigned when assemblies are built because the IDs for pin level are uniquely determined from the pin arrangement within each assembly type. Similarly, the assembly reporting IDs (assembly_id) are assigned in the core construction process.

Certain regions can be excluded from being labeled with an ID, for example dummy regions that will later be deleted. This can be accommodated by listing mesh objects in the "exclude_id" input parameter. IDs will not be assigned to these mesh objects. Usage of this parameter is helpful to retain sequential numbering when dummy region are later deleted, or to only label areas of interest.

Example Syntax

[pattern]
  type = PatternedCartesianMeshGenerator
  inputs = 'square_1 square_2'
  pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
  square_size = 48
  duct_sizes = '21 22 23'
  duct_intervals = '2 2 2'
  rotate_angle = 0
  duct_block_ids = '2000 2100 2200'
  background_block_id = 1500
[]

Input Parameters

inputsThe names of the meshes forming the pattern.
C++ Type:std::vector<MeshGeneratorName>
Controllable:No
Description:The names of the meshes forming the pattern.
patternA two-dimensional cartesian (square-shaped) array starting with the upper-left corner.It is composed of indexes into the inputs vector
C++ Type:std::vector<std::vector<unsigned int>>
Controllable:No
Description:A two-dimensional cartesian (square-shaped) array starting with the upper-left corner.It is composed of indexes into the inputs vector

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 square 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 square 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
Controllable:No
Description:A Boolean parameter that controls whether the core related metadata is generated for other MOOSE objects such as 'MultiControlDrumFunction' or not.
rotate_angle0Rotate the entire patterned mesh by a certain degrees that is defined here.
Default:0
C++ Type:double
Controllable:No
Description:Rotate the entire patterned mesh by a certain degrees that is defined here.
square_sizeSize (side length) of the outmost square boundary to be generated; this is required only when pattern type is 'expanded'.
C++ Type:double
Controllable:No
Description:Size (side length) of the outmost square boundary to be generated; this is required only when pattern type is 'expanded'.

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

assign_typecellType of integer ID assignment
Default:cell
C++ Type:MooseEnum
Options:cell, pattern, manual
Controllable:No
Description:Type of integer ID assignment
exclude_idName of input meshes to be excluded in ID generation
C++ Type:std::vector<MeshGeneratorName>
Controllable:No
Description:Name of input meshes to be excluded in ID generation
id_nameName of extra integer ID set
C++ Type:std::string
Controllable:No
Description:Name of extra integer ID set
id_patternUser-defined element IDs. A double-indexed array starting with the upper-left corner
C++ Type:std::vector<std::vector<unsigned long>>
Controllable:No
Description:User-defined element IDs. A double-indexed array starting with the upper-left corner

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
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.
create_inward_interface_boundariesFalseWhether the inward interface boundary sidesets are created.
Default:False
C++ Type:bool
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
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>
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.
pattern_boundaryexpandedThe boundary shape of the patterned mesh.
Default:expanded
C++ Type:MooseEnum
Options:none, expanded
Controllable:No
Description:The boundary shape of the patterned mesh.

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.
deform_non_circular_regionTrueWhether the non-circular region (outside the rings) can be deformed.
Default:True
C++ Type:bool
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>
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.
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

Input Files

(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/depletion_id.i)
(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/patterned_trimmed.i)
(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/alternative_pattern_reporting_id.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_mesh_generator/patterned_pattern_err2.i)
(modules/reactor/test/tests/meshgenerators/reporting_id/depletion_id/sub_pin_depletion_id.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_mesh_generator/patterned_pattern_err.i)
(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_core_reporting_id.i)
(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/assembly_trim.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_peripheral_modifier/patterned.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_mesh_generator/patterned_pattern_cd.i)
(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_assembly_reporting_id.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_mesh_generator/patterned_pattern.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_mesh_generator/patterned_2d.i)
(modules/reactor/test/tests/meshgenerators/patterned_cartesian_peripheral_modifier/single_square.i)
(modules/reactor/test/tests/meshgenerators/patterned_hex_peripheral_modifier/err_cart_input.i)

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [square_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 2.5
    ring_intervals = 1
    ring_block_ids = '40'
    ring_block_names = 'center_tri_2'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
    square_size = 48
    duct_sizes = '21 22 23'
    duct_intervals = '2 2 2'
    rotate_angle = 0
    duct_block_ids = '2000 2100 2200'
    background_block_id = 1500
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pattern'
    pattern = '0 0;
               0 0'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/depletion_id.i)

[Mesh]
  [pin1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '4 4 4 4'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '4 1'
    ring_block_ids = '1 2 5'
    background_block_ids = '6'
    polygon_size = 0.63
    flat_side_up = true
  []
  [pin2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '4 4 4 4'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '4 1'
    ring_block_ids = '3 4 5'
    background_block_ids = '6'
    polygon_size = 0.63
    flat_side_up = true
  []

  [assembly1]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 1  0  0  1;
                0  0  1  0;
                0  1  0  0;
                1  0  0  1'
    assign_type = 'cell'
    id_name = 'pin_id'
    pattern_boundary = 'none'
    square_size = 5.04
    generate_core_metadata = false
  []
  [core]
    type = PatternedCartesianMeshGenerator
    inputs = 'assembly1'
    pattern = '0 0;
               0 0'
    assign_type = 'cell'
    id_name = 'assembly_id'
    pattern_boundary = 'none'
    generate_core_metadata = true
  []
  [core_mat_id]
    type = SubdomainExtraElementIDGenerator
    input = core
    subdomains = '1 2 3 4 5 6'
    extra_element_id_names = 'material_id'
    extra_element_ids = '1 1 2 2 3 4'
  []
  [depletion_id]
    type = DepletionIDGenerator
    input = 'core_mat_id'
    id_name = 'assembly_id pin_id'
    material_id_name = 'material_id'
    exclude_id_name = 'material_id'
    exclude_id_value = '3 4'
  []
[]

(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/patterned_trimmed.i)

[Mesh]
  [sq_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 4.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_1'
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
    background_intervals = 2
    background_block_id = 25
    background_block_name = 'assem_block'
    square_size = 36
  []
  [trim_0]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 1 1 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_1]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '0 0 1 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_2]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 0 1 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_3]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 0 0 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_4]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 1 0 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_5]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 1 0 0'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_6]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '1 1 1 0'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_7]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '0 1 1 0'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [trim_8]
    type = CartesianMeshTrimmer
    input = pattern
    trim_peripheral_region = '0 1 1 1'
    peripheral_trimming_section_boundary = peripheral_section
  []
  [pattern2]
    type = PatternedCartesianMeshGenerator
    inputs = 'trim_0 trim_1 trim_2 trim_3 trim_4 trim_5 trim_6 trim_7 trim_8'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '3 2 1;
               4 0 8;
               5 6 7'
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/alternative_pattern_reporting_id.i)

[Mesh]
  [pin1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [pin2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [assembly1]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 1  0  0  1;
                0  0  1  0;
                0  1  0  0;
                1  0  0  1'
    assign_type = 'pattern'
    id_name = 'pin_id'
    pattern_boundary = 'none'
    square_size = 5.04
    generate_core_metadata = false
  []

  [assembly2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 0  1  1  0;
                1  0  0  1;
                1  0  0  1;
                0  1  1  0'
    id_pattern = ' 0  0  1  1;
                   0  0  1  1;
                   2  2  3  3;
                   2  2  3  3'
    assign_type = 'manual'
    id_name = 'pin_id'
    pattern_boundary = 'none'
    square_size = 5.04
    generate_core_metadata = false
  []

  [core]
    type = PatternedCartesianMeshGenerator
    inputs = 'assembly1 assembly2'
    pattern = '0  1;
               1  0'
    assign_type = 'cell'
    id_name = 'assembly_id'
    pattern_boundary = 'none'
    generate_core_metadata = true
  []
[]

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [square_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 2.5
    ring_intervals = 1
    ring_block_ids = '40'
    ring_block_names = 'center_tri_2'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern_1]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
    square_size = 48
    duct_sizes = '21 22 23'
    duct_intervals = '2 2 2'
    rotate_angle = 0
    duct_block_ids = '2000 2100 2200'
    background_block_id = 1500
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
    square_size = 47
    duct_sizes = '21 22 23'
    duct_intervals = '2 2 2'
    rotate_angle = 0
    duct_block_ids = '2000 2100 2200'
    background_block_id = 1500
  []
  [pattern_3]
    type = PatternedCartesianMeshGenerator
    inputs = 'pattern_1 pattern_2'
    pattern = '0 1;
               1 0'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

(modules/reactor/test/tests/meshgenerators/reporting_id/depletion_id/sub_pin_depletion_id.i)

[Mesh]
  [pin1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '4 4 4 4'
    background_intervals = 2
    polygon_size = 0.63
    polygon_size_style ='apothem'
    ring_radii = '0.2 0.4 0.5'
    ring_intervals = '2 2 1'
    ring_block_ids = '1 2 3 4'
    background_block_ids = '5'
    preserve_volumes = on
    flat_side_up = true
    sector_id_name = 'sector_id'
    ring_id_name = 'ring_id'
  []

  [pin2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '4 4 4 4'
    background_intervals = 2
    polygon_size = 0.63
    polygon_size_style ='apothem'
    ring_radii = '0.15 0.3 0.4'
    ring_intervals = '2 3 1'
    ring_block_ids = '6 7 8 9'
    background_block_ids = '10'
    preserve_volumes = on
    flat_side_up = true
    sector_id_name = 'sector_id'
    ring_id_name = 'ring_id'
  []

  [assembly]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 1  0;
                0  1'
    assign_type = 'cell'
    id_name = 'pin_id'
    pattern_boundary = 'none'
  []

  [assembly_mat_id]
    type = SubdomainExtraElementIDGenerator
    input = assembly
    subdomains = '1 2 3 4 5
                  6 7 8 9 10'
    extra_element_id_names = 'material_id'
    extra_element_ids = '1 1 1 8 9
                         2 2 2 8 9'
  []

  [depletion_id]
    type = DepletionIDGenerator
    input = 'assembly_mat_id'
    id_name = 'pin_id sector_id ring_id'
    material_id_name = 'material_id'
    exclude_id_name = 'material_id ring_id'
    exclude_id_value = '8 9; 0'
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[Outputs]
  [out]
    type = Exodus
    execute_on = timestep_end
    output_extra_element_ids = true
    extra_element_ids_to_output = 'sector_id ring_id depletion_id'
  []
[]

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [square_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 2.5
    ring_intervals = 1
    ring_block_ids = '40'
    ring_block_names = 'center_tri_2'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 1;
               1 0'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_core_reporting_id.i)

[Mesh]
  [pin1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [pin2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [assembly1]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 1  0  1  0;
                0  1  0  1;
                1  0  1  0;
                0  1  0  1'
    assign_type = 'cell'
    id_name = 'pin_id'
    pattern_boundary = 'none'
    generate_core_metadata = false
  []

  [assembly2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 0  1  1  0;
                1  0  0  1;
                1  0  0  1;
                0  1  1  0'
    assign_type = 'cell'
    id_name = 'pin_id'
    pattern_boundary = 'none'
    generate_core_metadata = false
  []

  [core]
    type = PatternedCartesianMeshGenerator
    inputs = 'assembly1 assembly2'
    pattern = '0  1;
               1  0'
    assign_type = 'cell'
    id_name = 'assembly_id'
    pattern_boundary = 'none'
    generate_core_metadata = true
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[AuxVariables]
  [pin_id]
    family = MONOMIAL
    order = CONSTANT
  []
  [assembly_id]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [set_pin_id]
    type = ExtraElementIDAux
    variable = pin_id
    extra_id_name = pin_id
  []
  [set_assembly_id]
    type = ExtraElementIDAux
    variable = assembly_id
    extra_id_name = assembly_id
  []
[]

[Outputs]
  exodus = true
  execute_on = timestep_end
[]

(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/assembly_trim.i)

[Mesh]
  [sq_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    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
    flat_side_up = true
  []
  [pattern]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_1'
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
    background_intervals = 2
    background_block_id = 25
    background_block_name = 'assem_block'
    square_size = 36
  []
  [pattern_mod]
    type = PatternedCartesianPeripheralModifier
    input = pattern
    new_num_sector = 7
    input_mesh_external_boundary = 10000
  []
  [pattern2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pattern'
    pattern_boundary = none
    generate_core_metadata = true
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
  []
  [peripheral_ring]
    type = PeripheralRingMeshGenerator
    input = pattern
    peripheral_ring_block_id = 200
    peripheral_layer_num = 2
    input_mesh_external_boundary = 10000
    peripheral_ring_radius = 30
  []
  [trim]
    type = CartesianMeshTrimmer
    input = pattern
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

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

new_num_sector = 10
num_layer = 2

[Mesh]
  [sq_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '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
    flat_side_up = true
    generate_side_specific_boundaries = true
  []
  [pattern_1]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_1'
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
    background_intervals = 1
    square_size = 34
  []
  [pmg_1]
    type = PatternedCartesianPeripheralModifier
    input = pattern_1
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [sq_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '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
    flat_side_up = true
    generate_side_specific_boundaries = true
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_2'
    pattern = '0 0 0 0;
               0 0 0 0;
               0 0 0 0;
               0 0 0 0'
    background_intervals = 1
    square_size = 34
  []
  [pmg_2]
    type = PatternedCartesianPeripheralModifier
    input = pattern_2
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [sq_3]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '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
    flat_side_up = true
    generate_side_specific_boundaries = true
  []
  [pattern_3]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_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'
    background_intervals = 1
    square_size = 34
  []
  [pmg_3]
    type = PatternedCartesianPeripheralModifier
    input = pattern_3
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [sq_4]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '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
    flat_side_up = true
    generate_side_specific_boundaries = true
  []
  [pattern_4]
    type = PatternedCartesianMeshGenerator
    inputs = 'sq_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'
    background_intervals = 1
    square_size = 34
  []
  [pmg_4]
    type = PatternedCartesianPeripheralModifier
    input = pattern_4
    input_mesh_external_boundary = 10000
    new_num_sector = ${new_num_sector}
    num_layers = ${num_layer}
  []
  [pattern_sum]
    type = PatternedCartesianMeshGenerator
    inputs = 'pmg_1 pmg_2 pmg_3 pmg_4'
    pattern = '1 2 3;
               2 0 2;
               3 2 1'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern_1]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1'
    pattern = '0 0 0 0;
               0 0 0 0;
               0 0 0 0;
               0 0 0 0'
    square_size = 48
    background_intervals = 1
    rotate_angle = 0
    background_block_id = 1500
  []
  [cd_1]
    type = CartesianConcentricCircleAdaptiveBoundaryMeshGenerator
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 2
    square_size = 48
    sides_to_adapt = '0 3'
    meshes_to_adapt_to = 'pattern_1 pattern_1'
    is_control_drum = true
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pattern_1 cd_1'
    pattern = '0 0;
               1 0'
    pattern_boundary = none
    generate_core_metadata = true
    generate_control_drum_positions_file = true
    assign_control_drum_id = true
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_assembly_reporting_id.i)

[Mesh]
  [pin1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [pin2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii ='0.4 0.5'
    ring_intervals = '1 1'
    polygon_size = 0.63
    flat_side_up = true
  []

  [assembly]
    type = PatternedCartesianMeshGenerator
    inputs = 'pin1 pin2'
    pattern = ' 1  0  1  0;
                0  1  0  1;
                1  0  1  0;
                0  1  0  1'
    assign_type = 'cell'
    id_name = 'pin_id'
    pattern_boundary = 'none'
  []
[]

[Executioner]
  type = Steady
[]

[Problem]
  solve = false
[]

[AuxVariables]
  [pin_id]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [set_pin_id]
    type = ExtraElementIDAux
    variable = pin_id
    extra_id_name = pin_id
  []
[]

[Outputs]
  exodus = true
  execute_on = timestep_end
[]

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [square_2]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 2.5
    ring_intervals = 1
    ring_block_ids = '40'
    ring_block_names = 'center_tri_2'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
  []
  [pattern]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
    square_size = 48
    duct_sizes = '21 22 23'
    duct_intervals = '2 2 2'
    rotate_angle = 0
    duct_block_ids = '2000 2100 2200'
    background_block_id = 1500
  []
  [pattern_2]
    type = PatternedCartesianMeshGenerator
    inputs = 'pattern'
    pattern = '0 0;
               0 0'
    pattern_boundary = none
    generate_core_metadata = true
  []
[]

[Outputs]
  [out]
    type = Exodus
    output_extra_element_ids = false
  []
[]

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

[Mesh]
  [square_1]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    background_intervals = 1
    ring_radii = 3.0
    ring_intervals = 1
    ring_block_ids = '10'
    ring_block_names = 'center_tri_1'
    background_block_ids = 20
    background_block_names = background
    polygon_size = 5.0
    preserve_volumes = on
    flat_side_up = true
    generate_side_specific_boundaries = true
  []
  [square_2]
      type = PolygonConcentricCircleMeshGenerator
      num_sides = 4
      num_sectors_per_side = '2 2 2 2'
      background_intervals = 1
      ring_radii = 2.5
      ring_intervals = 1
      ring_block_ids = '40'
      ring_block_names = 'center_tri_2'
      background_block_ids = 20
      background_block_names = background
      polygon_size = 5.0
      preserve_volumes = on
      flat_side_up = true
      generate_side_specific_boundaries = true
  []
  [pattern]
    type = PatternedCartesianMeshGenerator
    inputs = 'square_1 square_2'
    pattern = '0 0 0 0;
               0 1 0 0;
               0 0 1 0;
               0 0 0 0'
  []
[]

(modules/reactor/test/tests/meshgenerators/patterned_cartesian_peripheral_modifier/single_square.i)

[Mesh]
  inactive = 'pmg2 pmg3'
  [square]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    flat_side_up = true
    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 = PatternedCartesianMeshGenerator
    inputs = 'square'
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
    background_intervals = 2
    square_size = 34
    #duct_sizes = '15 15.5'
    #duct_intervals = '1 2'
  []
  [pmg]
    type = PatternedCartesianPeripheralModifier
    input = pattern
    input_mesh_external_boundary = 10000
    new_num_sector = 10
    num_layers = 2
  []
  [pmg2]
    type = PatternedCartesianPeripheralModifier
    input = pmg
    input_mesh_external_boundary = 10000
    new_num_sector = 10
    num_layers = 2
  []
  [pmg3]
    type = PatternedHexPeripheralModifier
    input = pattern
    input_mesh_external_boundary = 10000
    new_num_sector = 10
    num_layers = 2
  []
[]

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

[Mesh]
  [square]
    type = PolygonConcentricCircleMeshGenerator
    num_sides = 4
    num_sectors_per_side = '2 2 2 2'
    flat_side_up = true
    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 = PatternedCartesianMeshGenerator
    inputs = 'square'
    pattern = '0 0 0;
               0 0 0;
               0 0 0'
    background_intervals = 2
    square_size = 34
  []
  [pmg]
    type = PatternedHexPeripheralModifier
    input = pattern
    input_mesh_external_boundary = 10000
    new_num_sector = 10
    num_layers = 2
  []
[]

Overview
Geometry Information
Control Drum Related MeshMetaData
Interface Boundaries
Reporting ID Information
Example Syntax
Input Parameters
Input Files

PatternedCartesianMeshGenerator

Overview

Geometry Information

Control Drum Related MeshMetaData

Interface Boundaries

Reporting ID Information

Example Syntax

Input Parameters

Required Parameters

Optional Parameters

Control Drum Parameters

Reporting Id Parameters

Customized Subdomain/Boundary Parameters

Mesh Density Parameters

Advanced Parameters

Debugging Parameters

Input Files

inputs

pattern

inputs

pattern_boundary

inputs

pattern_boundary

duct_sizes

duct_sizes_style

square_size

square_size

deform_non_circular_region

generate_core_metadata

inputs

generate_control_drum_positions_file

position_file

assign_control_drum_id

inputs

create_inward_interface_boundaries

create_outward_interface_boundaries

id_name

assign_type

id_pattern

id_name

exclude_id

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

(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/depletion_id.i)

(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/patterned_trimmed.i)

(tutorials/tutorial04_meshing/app/test/tests/base_mesh_generators/alternative_pattern_reporting_id.i)

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

(modules/reactor/test/tests/meshgenerators/reporting_id/depletion_id/sub_pin_depletion_id.i)

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

(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_core_reporting_id.i)

(modules/reactor/test/tests/meshgenerators/cartesian_mesh_trimmer/assembly_trim.i)

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

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

(modules/reactor/test/tests/meshgenerators/reporting_id/cartesian_id/patterned_cartesian_assembly_reporting_id.i)

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

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

(modules/reactor/test/tests/meshgenerators/patterned_cartesian_peripheral_modifier/single_square.i)

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