PlaneIDMeshGenerator

Overview

The PlaneIDMeshGenerator object applies an extra IDs to axial planes defined in a extruded mesh.

Extra ID Control

The PlaneIDMeshGenerator takes a mesh object and its axial layer structure as input. This axial plane structure given in "plane_coordinates" contains a list of coordinates defining each plane from bottom to top. If there are N planes, N+1 coordinate points should be defined here.

If each axial plane is uniformly sub-divided into multiple layers during the extrusion, distinct extra IDs can be optionally assigned to individual layers in each plane. "num_ids_per_plane" defines the number of unique IDs in each plane defined in "plane_coordinates".

Note that this generator only works for extruded geometries where the concept of axial layer is valid. The axis of plane can be specified using "plane_axis".

Example Syntax

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  [pin2d]
    type = ConcentricCircleMeshGenerator<<<{"description": "This ConcentricCircleMeshGenerator source code is to generate concentric circle meshes.", "href": "ConcentricCircleMeshGenerator.html"}>>>
    num_sectors<<<{"description": "num_sectors % 2 = 0, num_sectors > 0Number of azimuthal sectors in each quadrant'num_sectors' must be an even number."}>>> = 2
    radii<<<{"description": "Radii of major concentric circles"}>>> = '0.4 0.5'
    rings<<<{"description": "Number of rings in each circle or in the enclosing square"}>>> = '1 1 1'
    has_outer_square<<<{"description": "It determines if meshes for a outer square are added to concentric circle meshes."}>>> = on
    pitch<<<{"description": "The enclosing square can be added to the completed concentric circle mesh.Elements are quad meshes."}>>> = 1.26
    preserve_volumes<<<{"description": "Volume of concentric circles can be preserved using this function."}>>> = yes
    smoothing_max_it<<<{"description": "Number of Laplacian smoothing iterations"}>>> = 3
  []
  [pin3d]
    type = AdvancedExtruderGenerator<<<{"description": "Extrudes a 1D mesh into 2D, or a 2D mesh into 3D, can have a variable height for each elevation, variable number of layers within each elevation, variable growth factors of axial element sizes within each elevation and remap subdomain_ids, boundary_ids and element extra integers within each elevation as well as interface boundaries between neighboring elevation layers.", "href": "AdvancedExtruderGenerator.html"}>>>
    input<<<{"description": "The mesh to extrude"}>>> = 'pin2d'
    heights<<<{"description": "The height of each elevation"}>>> = '5.0 5.0 5.0'
    direction<<<{"description": "A vector that points in the direction to extrude (note, this will be normalized internally - so don't worry about it here)"}>>> = '0 0 1'
    num_layers<<<{"description": "The number of layers for each elevation - must be num_elevations in length!"}>>> = '2 2 2'
  []
  [pin3d_id]
    type = PlaneIDMeshGenerator<<<{"description": "Adds an extra element integer that identifies planes in a mesh.", "href": "PlaneIDMeshGenerator.html"}>>>
    input<<<{"description": "The mesh we want to modify"}>>> = 'pin3d'
    plane_coordinates<<<{"description": "Coordinates of planes along the axis. The origin are at x/y/z=0 depending on the axis"}>>> = '0.0 5.0 10.0 15.0'
    num_ids_per_plane<<<{"description": "Number of unique ids per plane"}>>> = ' 1 2 1'
    plane_axis<<<{"description": "Axis of plane"}>>> = 'z'
    id_name<<<{"description": "Name of extra integer ID set"}>>> = 'plane_id'
  []
[]

Input Parameters