forked from idaholab/moose
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Doco for GridPartioner closes idaholab#11437
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
24 changes: 24 additions & 0 deletions
24
framework/doc/content/documentation/systems/Mesh/Partitioner/GridPartitioner.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# GridPartitioner | ||
|
||
!syntax description /Mesh/Partitioner/GridPartitioner | ||
|
||
## Description | ||
|
||
Partitions the mesh by creating a grid in `x,y,z` and assigning each element of the mesh to a separate "cell" within the grid. This is useful when you have simple cartesian meshes and you just want to specify partitioning fairly directly. Sometimes a human is the best partitioner! | ||
|
||
!alert warning | ||
The number of cells (`nx*ny*nz`) MUST be equal to the number of MPI processes you're attempting to use! | ||
|
||
## How it Works | ||
|
||
The GridPartitioner works by creating a [/GeneratedMesh.md] for the "grid". That's the reason why this object takes similar input file parameters to a [/GeneratedMesh.md]. The GeneratedMesh created by GridPartitioner is guaranteed to contain the original domain within it. | ||
|
||
To assign the processor IDs the centroid of each element of the mesh to be partitioned is searched for in the GeneratedMesh. The ID of the element of the GeneratedMesh that it lies within is then assigned as the `processor_id`. | ||
|
||
!syntax parameters /Mesh/Partitioner/LibmeshPartitioner | ||
|
||
!syntax inputs /Mesh/Partitioner/LibmeshPartitioner | ||
|
||
!syntax children /Mesh/Partitioner/LibmeshPartitioner | ||
|
||
!bibtex bibliography |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters