- inputThe mesh we want to modify
C++ Type:MeshGeneratorName
Controllable:No
Description:The mesh we want to modify
- normalThe normal that defines the plane
C++ Type:libMesh::VectorValue<double>
Unit:(no unit assumed)
Controllable:No
Description:The normal that defines the plane
- pointThe point that defines the plane
C++ Type:libMesh::Point
Controllable:No
Description:The point that defines the plane
PlaneDeletionGenerator
Removes elements lying 'above' the plane (in the direction of the normal).
Overview
Allows for deletion of elements that lie on one side of a plane. The plane can be specified via a point and a vector that is normal to the plane. All elements whose centroids lie "above" (in the direction of the normal vector) the plane will be removed from the mesh.
An optional new_boundary parameter can also be specified which will make any newly-created free-surfaces have that boundary ID.
Example
[Mesh]
[generated]
type = GeneratedMeshGenerator
dim = 3
nx = 4
ny = 4
nz = 4
[]
[deleter]
type = PlaneDeletionGenerator
point = '0.5 0.5 0'
normal = '-1 1 0'
input = generated
new_boundary = 6
[]
[]
The Original Mesh
With the elements removed (and showing the new boundary)
Input Parameters
- delete_exteriorsTrueWhether to delete lower-d elements whose interior parents are deleted
Default:True
C++ Type:bool
Controllable:No
Description:Whether to delete lower-d elements whose interior parents are deleted
- new_boundaryoptional boundary name to assign to the cut surface
C++ Type:BoundaryName
Controllable:No
Description:optional boundary name to assign to the cut surface
Optional Parameters
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
- save_with_nameKeep the mesh from this mesh generator in memory with the name specified
C++ Type:std::string
Controllable:No
Description:Keep the mesh from this mesh generator in memory with the name specified
Advanced Parameters
- nemesisFalseWhether or not to output the mesh file in the nemesisformat (only if output = true)
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to output the mesh file in the nemesisformat (only if output = true)
- outputFalseWhether or not to output the mesh file after generating the mesh
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to output the mesh file after generating the mesh
- show_infoFalseWhether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)
Debugging Parameters
Input Files
(test/tests/meshgenerators/unique_extra_id_mesh_generator/unique_id_cut.i)
[Mesh]
[fmg]
type = FileMeshGenerator
file = unique_id_cut_in.e
exodus_extra_element_integers = 'id1 id0'
[]
[parse_id]
type = UniqueExtraIDMeshGenerator
input = fmg
id_name = 'id1 id0'
new_id_name = 'parsed_id'
[]
[deleter]
type = PlaneDeletionGenerator
point = '0 0 0'
normal = '1 1 0'
input = parse_id
new_boundary = new_side
[]
[]
[Executioner]
type = Steady
[]
[Problem]
solve = false
[]
[AuxVariables]
[parsed_id]
family = MONOMIAL
order = CONSTANT
[]
[]
[AuxKernels]
[aux_parsed_id]
type = ExtraElementIDAux
variable = parsed_id
extra_id_name = parsed_id
[]
[]
[Outputs]
exodus = true
execute_on = timestep_end
[]
(test/tests/meshgenerators/plane_deletion/plane_deletion.i)
[Mesh]
[deleter]
type = PlaneDeletionGenerator
point = '0.5 0.5 0'
normal = '-1 0 0'
input = generated
new_boundary = 6
[]
[generated]
type = GeneratedMeshGenerator
dim = 3
nx = 4
ny = 4
nz = 4
[]
[]
[Variables]
[u]
[]
[]
[Kernels]
[diff]
type = Diffusion
variable = u
[]
[]
[BCs]
[left]
type = DirichletBC
variable = u
boundary = 'left'
value = 0
[]
[right]
type = DirichletBC
variable = u
boundary = 'right'
value = 1
[]
[]
[Executioner]
type = Steady
solve_type = PJFNK
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre boomeramg'
[]
[Outputs]
exodus = true
[]
(tutorials/tutorial04_meshing/app/test/tests/reactor_examples/hpmr/hpmr.i)
# Heat Pipe-Cooled Micro Reactor - 3D Core with Heterogeneous Assemblies
[Mesh]
################################# # This parameter allows us to execute the file but stop at this block so we can see intermediate output.
final_generator = moderator_pincell # User: Change this based on build step
################################
# step 1: moderator_pincell
# step 2: fuel_assembly
# optional: fuel_core
# step 3: cd1
# step 4: refl1
# step 5: core
# step 6: del_dummy
# step 7: outer_shield
# step 8: coreslice_2
# step 9: extrude
### Step 1. Create Pin Unit Cells
# There are 3 unique pin in the fuel assembly
[moderator_pincell]
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
background_block_ids = '10'
polygon_size = 1.15
polygon_size_style ='apothem'
ring_radii = '0.825 0.92'
ring_intervals = '2 1'
ring_block_ids = '103 100 101' # 103 is tri mesh
preserve_volumes = on
quad_center_elements = false
[]
[heatpipe_pincell]
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
background_block_ids = '10'
polygon_size = 1.15
polygon_size_style ='apothem'
ring_radii = '0.97 1.07'
ring_intervals = '2 1'
ring_block_ids = '203 200 201' # 203 is tri mesh
preserve_volumes = on
quad_center_elements = false
[]
[fuel_pincell]
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
background_block_ids = '10'
polygon_size = 1.15
polygon_size_style ='apothem'
ring_radii = '1'
ring_intervals = '2'
ring_block_ids = '303 301' # 303 is tri mesh
preserve_volumes = on
quad_center_elements = false
[]
### Step 2. Create Patterned Hexagonal Fuel Assembly
[fuel_assembly]
type = PatternedHexMeshGenerator
inputs = 'fuel_pincell heatpipe_pincell moderator_pincell'
hexagon_size = 13.376
background_block_id = 10
background_intervals = 1
pattern = '1 0 1 0 1 0 1;
0 2 0 2 0 2 0 0;
1 0 1 0 1 0 1 2 1;
0 2 0 2 0 2 0 0 0 0;
1 0 1 0 1 0 1 2 1 2 1;
0 2 0 2 0 2 0 0 0 0 0 0;
1 0 1 0 1 0 1 2 1 2 1 2 1;
0 2 0 2 0 2 0 0 0 0 0 0;
1 0 1 0 1 0 1 2 1 2 1;
0 2 0 2 0 2 0 0 0 0;
1 0 1 0 1 0 1 2 1;
0 2 0 2 0 2 0 0;
1 0 1 0 1 0 1'
[]
### Optional. Create Fuel-Only Core
# optional example, create a core made only of fuel assemblies
[fuel_core]
type = PatternedHexMeshGenerator
inputs = 'fuel_assembly'
# Pattern ID 0
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 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'
rotate_angle = 60
[]
### Step 3. Create Control Drum Assembly
# 12 control drum (cd1-cd12) meshes are needed for different locations and node boundary conditions
[cd1_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '3 4'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd1]
type = AzimuthalBlockSplitGenerator
input = cd1_step1
start_angle = 45
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd2_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '2 3 4'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd2]
type = AzimuthalBlockSplitGenerator
input = cd2_step1
start_angle = 15
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd3_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '2 3'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd3]
type = AzimuthalBlockSplitGenerator
input = cd3_step1
start_angle = 345
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd4_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '1 2 3'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd4]
type = AzimuthalBlockSplitGenerator
input = cd4_step1
start_angle = 315
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd5_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '1 2'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd5]
type = AzimuthalBlockSplitGenerator
input = cd5_step1
start_angle = 285
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd6_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = ' fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '0 1 2'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd6]
type = AzimuthalBlockSplitGenerator
input = cd6_step1
start_angle = 255
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd7_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '0 1'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd7]
type = AzimuthalBlockSplitGenerator
input = cd7_step1
start_angle = 225
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd8_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = ' fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '0 1 5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd8]
type = AzimuthalBlockSplitGenerator
input = cd8_step1
start_angle = 195
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd9_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '0 5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd9]
type = AzimuthalBlockSplitGenerator
input = cd9_step1
start_angle = 165
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd10_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '0 4 5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd10]
type = AzimuthalBlockSplitGenerator
input = cd10_step1
start_angle = 135
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd11_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly'
sides_to_adapt = '4 5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd11]
type = AzimuthalBlockSplitGenerator
input = cd11_step1
start_angle = 105
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
[cd12_step1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '3 4 5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = 504
ring_radii = '12.25 13.25'
ring_intervals = '2 1'
ring_block_ids = '500 501 502'
preserve_volumes = true
is_control_drum = true
[]
[cd12]
type = AzimuthalBlockSplitGenerator
input = cd12_step1
start_angle = 75
angle_range = 90
old_blocks = 502
new_block_ids = 503
[]
### Step 4. Create Additional Assemblies (Reflector, Air, Dummy)
# 6 reflector meshes (refl1-refl6) are needed for difference node boundary conditions
# 1 central air hole
# dummy assembly for patterning
[refl1]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '4'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[refl2]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '5'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[refl3]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '0'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[refl4]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '1'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[refl5]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '2'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[refl6]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
meshes_to_adapt_to = 'fuel_assembly'
sides_to_adapt = '3'
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '400 401'
[]
[air_center]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
num_sectors_per_side= '4 4 4 4 4 4'
meshes_to_adapt_to = 'fuel_assembly fuel_assembly fuel_assembly fuel_assembly fuel_assembly fuel_assembly'
sides_to_adapt = '0 1 2 3 4 5'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '600 601'
[]
[dummy]
type =HexagonConcentricCircleAdaptiveBoundaryMeshGenerator
num_sectors_per_side= '4 4 4 4 4 4'
hexagon_size = 13.376
background_intervals = 2
background_block_ids = '700 701'
# external_boundary_id = 9998
[]
### Step 5. Create Patterned Full Core
[core]
type = PatternedHexMeshGenerator
inputs = 'fuel_assembly cd1 cd2 cd3 cd4 cd5 cd6 cd7 cd8 cd9 cd10 cd11 cd12 refl1 refl2 refl3 refl4 refl5 refl6 dummy air_center'
# Pattern ID 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
pattern_boundary = none
generate_core_metadata = true
pattern = '19 13 1 18 19;
13 12 0 0 2 18;
11 0 0 0 0 0 3;
14 0 0 0 0 0 0 17;
19 10 0 0 20 0 0 4 19;
14 0 0 0 0 0 0 17;
9 0 0 0 0 0 5;
15 8 0 0 6 16;
19 15 7 16 19'
rotate_angle = 60
[]
### Step 6. Delete Dummy Assemblies
[del_dummy]
type = BlockDeletionGenerator
block = '700 701'
input = core
new_boundary = 10000
[]
### Step 7. Add Core Periphery
[outer_shield]
type = PeripheralRingMeshGenerator
input = del_dummy
peripheral_layer_num = 1
peripheral_ring_radius = 115.0
input_mesh_external_boundary = 10000
peripheral_ring_block_id = 250
peripheral_ring_block_name = outer_shield
[]
### Step 8. Slice to 1/6 Core
[coreslice_1]
type = PlaneDeletionGenerator
point = '0 0 0'
normal = '10 17.32 0'
input = outer_shield
new_boundary = 147
[]
[coreslice_2]
type = PlaneDeletionGenerator
point = '0 0 0'
normal = '10 -17.32 0'
input = coreslice_1
new_boundary = 147
[]
### Step 9. Extrude to 3D
[extrude]
type = AdvancedExtruderGenerator
input = coreslice_2
heights = '20 160 20'
num_layers = '1 8 1'
direction = '0 0 1'
subdomain_swaps = '10 1000 100 1000 101 1000 103 1003 200 1000 201 1000 203 1003 301 1000 303 1003;
10 10 100 100 101 101 103 103 200 200 201 201 203 203 301 301 303 303;
10 1000 100 1000 101 1000 103 1003 200 200 201 201 203 203 301 1000 303 1003'
top_boundary = 2000
bottom_boundary = 3000
[]
[]
(modules/electromagnetics/test/tests/auxkernels/current_density/current_density.i)
# This test creates a current density field in graphite running from the top left
# corner of the domain (powered with a potential of 1 V) into the bottom right
# corner (a slice has been taken from this corner to provide a grounded surface).
# Current flow should proceed from the powered surfaces to the grounded surface.
[Mesh]
[box]
type = GeneratedMeshGenerator
dim = 2
nx = 50
ny = 50
elem_type = TRI6
[]
[delete_corner]
type = PlaneDeletionGenerator
input = box
point = '0.9 0.1 0'
normal = '1 -1 0'
new_boundary = 'corner'
[]
[]
[Variables]
[potential]
family = LAGRANGE
order = FIRST
[]
[]
[AuxVariables]
[J]
family = NEDELEC_ONE
order = FIRST
[]
[]
[Kernels]
[poisson]
type = Diffusion
variable = potential
[]
[]
[BCs]
[driven]
type = DirichletBC
variable = potential
value = 1
boundary = 'top left'
[]
[grounded]
type = DirichletBC
variable = potential
value = 0
boundary = 'corner'
[]
[]
[AuxKernels]
[current_density]
type = ADCurrentDensity
variable = J
potential = potential
[]
[]
[Materials]
[conductivity] # Electrical conductivity for graphite at 293.15 K in S/m
type = ADGenericConstantMaterial # perpendicular to basal plane
prop_names = 'electrical_conductivity' # Citation: H. Pierson, "Handbook of carbon, graphite,
prop_values = 3.33e2 # diamond, and fullerenes: properties, processing,
[] # and applications," p. 61, William Andrew, 1993.
[]
[Executioner]
type = Steady
solve_type = NEWTON
petsc_options_iname = '-pc_type'
petsc_options_value = 'lu'
[]
[Outputs]
exodus = true
print_linear_converged_reason = false
print_nonlinear_converged_reason = false
[]