Skip to content

Commit 78e8590

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

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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 from the starting point with the starting direction:
10+
The following heuristics are implemented for following the nodeset:
11+
12+
- Sphere-based nodeset centroid search
13+
- the current point is moved by [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/dx) towards the current direction
14+
- the local centroid of all nodes in the target nodeset and closer than [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/search_radius) to the current point is found
15+
- the current direction is updated to be from the current point to the centroid
16+
- the displacement of the current point is annulled, and replaced by a displacement of magnitude [!param](/Mesh/PolyLineMeshFollowingNodeSetGenerator/dx) towards the centroid
17+
- Ignoring nodes behind
18+
- only nodes from the nodeset that are also ahead of the current point with the current direction are considered
19+
20+
!alert note
21+
Because of the use of heuristics rather than a global solve, the 1D polyline solution is highly dependent on the parameters chosen.
22+
The user should tune these parameters to fit their needs. Notably, the number of edges can be reduced to prevent the polyline from
23+
backtracking after having reached the end of the nodeset.
24+
25+
!syntax parameters /Mesh/PolyLineMeshFollowingNodeSetGenerator
26+
27+
!syntax inputs /Mesh/PolyLineMeshFollowingNodeSetGenerator

0 commit comments

Comments
 (0)