AllSideSetsByNormalsGenerator

Adds sidesets to the entire mesh based on unique normals.

Overview

This mesh generator is useful for adding all possible sidesets to a mesh based on unique normal directions. It works well for more regular shapes that don't have curves or many disjoint surfaces with similar normals. If desired however, it is capable of following a slowly changing normal around a surface so that a curve can be assigned a single sideset. This is accomplished by setting fixed_normal to false. In this case a cylinder mesh can be given exactly three normals, one for the two and bottom respectively, and a third normal for the curved surface of the cylinder.

note

The sideset number assignment is not predictable. This utility assigns sideset numbering based on the unique normals seen while iterating over the mesh. Further enhancements could be made to more carefully control this assignment.

Input Parameters

inputThe mesh we want to modify
C++ Type:MeshGeneratorName
Controllable:No
Description:The mesh we want to modify

Required Parameters

replaceFalseIf true, replace the old sidesets. If false, the current sidesets (if any) will be preserved.
Default:False
C++ Type:bool
Controllable:No
Description:If true, replace the old sidesets. If false, the current sidesets (if any) will be preserved.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:No
Description:Set the enabled status of the MooseObject.
save_with_nameKeep the mesh from this mesh generator in memory with the name specified
C++ Type:std::string
Controllable:No
Description:Keep the mesh from this mesh generator in memory with the name specified

Advanced Parameters

included_boundariesA set of boundary names or ids whose sides will be included in the new sidesets
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:A set of boundary names or ids whose sides will be included in the new sidesets
included_neighborsA set of neighboring subdomain names or ids. A face is only added if the subdomain id of the neighbor is in this set
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:A set of neighboring subdomain names or ids. A face is only added if the subdomain id of the neighbor is in this set
included_subdomainsA set of subdomain names or ids whose sides will be included in the new sidesets
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:A set of subdomain names or ids whose sides will be included in the new sidesets

Sideset Restrictions 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/add_all_side_sets_generators/less_simple.i)
(test/tests/misc/check_mesh_meta_data/check_mesh_meta_data_test.i)
(modules/heat_transfer/test/tests/view_factors/view_factor_3d_non_planar_face.i)
(test/tests/meshgenerators/sidesets_by_normals_generator/replace.i)
(test/tests/meshgenerators/sidesets_by_normals_generator/less_simple.i)
(test/tests/meshgenerators/sidesets_by_normals_generator/simple.i)
(test/tests/meshgenerators/add_all_side_sets_generators/simple.i)

(test/tests/meshgenerators/add_all_side_sets_generators/less_simple.i)

[Mesh]
  [read]
    type = FileMeshGenerator
    file = reactor.e
  []
  [block_1]
    type = AllSideSetsByNormalsGenerator
    input = read
  []
[]

# This input file is intended to be run with the "--mesh-only" option so
# no other sections are required

(test/tests/misc/check_mesh_meta_data/check_mesh_meta_data_test.i)

[Mesh]
  [square]
    type = GeneratedMeshGenerator
    nx = 2
    ny = 2
    dim = 2
  []
  [normal]
    type = AllSideSetsByNormalsGenerator
    input = square
  []
[]

[Debug]
  show_mesh_meta_data = true
[]

[CheckMeshMetaData]
  mesh_generator_name = normal
  mesh_meta_data_name = boundary_normals
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Steady
[]

(modules/heat_transfer/test/tests/view_factors/view_factor_3d_non_planar_face.i)

[GlobalParams]
  view_factor_object_name = rt_vf
[]

[Mesh]
  [with_a_non_planar]
    type = ElementGenerator
    nodal_positions = '-1 -1 0
                       1 -1 0
                       1 1 0
                       -1 1 0
                       -1 -1 2
                       1 -1 2
                       1 1 2
                       -1 1 1'
    element_connectivity = '0 1 2 3 4 5 6 7'
    elem_type = 'HEX8'
  []
  [sides]
    type = AllSideSetsByNormalsGenerator
    input = with_a_non_planar
  []
  [rename]
    type = RenameBoundaryGenerator
    input = sides
    old_boundary = '1 2 3 4 5 6'
    new_boundary = 'bottom front left back right top'
  []
[]

[UserObjects]
  [vf_study]
    type = ViewFactorRayStudy
    execute_on = INITIAL
    boundary = 'bottom front left back right top'
    face_order = CONSTANT
    polar_quad_order = 3
    azimuthal_quad_order = 200
    face_type = GAUSS
    warn_non_planar = false
  []

  [rt_vf]
    type = RayTracingViewFactor
    boundary = 'bottom front left back right top'
    execute_on = INITIAL
    ray_study_name = vf_study
    normalize_view_factor = false
  []
[]

[RayBCs]
  [vf]
    type = ViewFactorRayBC
    boundary = 'left right front back bottom top'
  []
[]

## For convenience, the "view_factor_object_name" for these
## PPs are set in global params for switching between methods
[Postprocessors]
  [top_bottom]
    type = ViewFactorPP
    from_boundary = top
    to_boundary = bottom
  []
  [top_left]
    type = ViewFactorPP
    from_boundary = top
    to_boundary = left
  []
  [top_right]
    type = ViewFactorPP
    from_boundary = top
    to_boundary = right
  []
  [top_front]
    type = ViewFactorPP
    from_boundary = top
    to_boundary = front
  []
  [top_back]
    type = ViewFactorPP
    from_boundary = top
    to_boundary = back
  []
  [sum]
    type = ParsedPostprocessor
    expression = 'top_back + top_bottom + top_front + top_right + top_left'
    pp_names = 'top_back top_bottom top_front top_right top_left'
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
  [Quadrature] # higher order quadrature for unobstructed
    order = SECOND
  []
[]

[Outputs]
  csv = true
[]

(test/tests/meshgenerators/sidesets_by_normals_generator/replace.i)

[Mesh]
  # Creates (by default) the sidesets [0, 1, 2, 3]
  [gmg]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 10
    ny = 10
  []

  # Creates the sidesets [5, 6, 7, 8] and removes [0, 1, 2, 3]
  [generate_sidesets]
    type = AllSideSetsByNormalsGenerator
    input = gmg
    replace = true
  []
[]

(test/tests/meshgenerators/sidesets_by_normals_generator/less_simple.i)

[Mesh]
  [./fmg]
    type = FileMeshGenerator
    file = reactor.e
  []

  [./generate_sidesets]
    type = AllSideSetsByNormalsGenerator
    input = fmg
  []
[]

[Outputs]
  exodus = true
[]

(test/tests/meshgenerators/sidesets_by_normals_generator/simple.i)

[Mesh]
  [./fmg]
    type = FileMeshGenerator
    file = twoblocks.e
  []

  [./generate_sidesets]
    type = AllSideSetsByNormalsGenerator
    input = fmg
  []
[]

[Outputs]
  exodus = true
[]

(test/tests/meshgenerators/add_all_side_sets_generators/simple.i)

[Mesh]
  [read]
    type = FileMeshGenerator
    file = twoblocks.e
  []
  [block_1]
    type = AllSideSetsByNormalsGenerator
    input = read
  []
[]

# This input file is intended to be run with the "--mesh-only" option so
# no other sections are required

Overview
Input Parameters
Input Files