add destination_ranks

Alpine-DAV · Oct 30, 2024 · 6efd5e7 · 6efd5e7
1 parent 19dff73
commit 6efd5e7
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/docs/sphinx/Actions/Pipelines.rst b/src/docs/sphinx/Actions/Pipelines.rst
@@ -1348,6 +1348,27 @@ can be set to "any" if it is desired that the field selection will be applied to
 all domains in the input mesh. The domain_id value can still be set to specific
 integer values to limit the set of domains over which the selection will be applied.
 
++------------------+-----------------------------------------+------------------------------------------+
+| **Option**       | **Description**                         | **Example**                              |
++------------------+-----------------------------------------+------------------------------------------+
+| field            | The name of the element field that will | .. code:: yaml                           |
+|                  | be used for partitioning. The field     |                                          |
+|                  | shall contain non-negative domain       |    selections:                           |
+|                  | numbers.                                |       type: "field"                      |
+|                  |                                         |       domain_id: "any"                   |
+|                  |                                         |                                          |
++------------------+-----------------------------------------+------------------------------------------+
+| destination_ranks| An optional list of integers            | .. code:: yaml                           |
+|                  | representing the MPI rank where the     |                                          |
+|                  | domain will be sent after partitioning. |    selections:                           |
+|                  | This option can help ensure domains for |       type: "field"                      |
+|                  | topologies partitioned via multiple     |       field: "albatroaz"                 |
+|                  | calls to partition() end up together on |       domain_id: "any"                   |
+|                  | a target MPI rank. The example shows    |       destination_ranks: [0,1,2,3]       |
+|                  | domain 0 going to MPI rank 0 and so on. |                                          |
+|                  |                                         |                                          |
++------------------+-----------------------------------------+------------------------------------------+
+
 .. code:: cpp
 
   conduit::Node pipelines;