Skip to content

Commit 5f433f9

Browse files
committed
Add documentation for new MG
refs #31851
1 parent 422d0dc commit 5f433f9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# PolyLineMeshFollowingNodeSetGenerator
2+
3+
!syntax description /Mesh/PolyLineMeshFollowingNodeSetGenerator
4+
5+
Using the `PolyLineMeshFollowingNodeSetGenerator` object from within the
6+
[Mesh](/Mesh/index.md) block of the input file will construct an open
7+
or closed (looped) one-dimensional manifold of Edge elements.
8+
9+
The polyline is generated iteratively, starting from the [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/starting_point),
10+
taking the first step following the [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/starting_direction):
11+
The following heuristics are implemented for following the nodeset:
12+
13+
- Sphere-based nodeset centroid search
14+
- the current point is moved by [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/dx) towards the current direction
15+
- the local centroid of all nodes in the target nodeset and closer than [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/search_radius) to the current point is found
16+
- the current direction is updated to be from the current point to the centroid
17+
- the displacement of the current point is annulled, and replaced by a displacement of magnitude [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/dx) towards the centroid
18+
- Ignoring nodes behind, activated with the [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/ignore_nodes_behind) parameter
19+
- only nodes from the nodeset that are also ahead of the current point with the current direction are considered
20+
21+
!alert note
22+
Because of the use of heuristics rather than a global solve, the 1D polyline solution is highly dependent on the parameters chosen.
23+
The user should tune these parameters to fit their needs. Notably, the number of edges can be reduced to prevent the polyline from
24+
backtracking after having reached the end of the nodeset.
25+
26+
!syntax parameters /Mesh/PolyLineMeshFollowingNodeSetGenerator
27+
28+
!syntax inputs /Mesh/PolyLineMeshFollowingNodeSetGenerator

0 commit comments

Comments
 (0)