Skip to content

Commit 4868c87

Browse files
committed
docs(init): update with new prototypes
1 parent a68902e commit 4868c87

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/api/core.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ KokkosComm provides a unified interface for initializing and finalizing both Kok
4444

4545
.. Attention:: It is mandatory to use KokkosComm's initialization and finalization functions instead of their respective Kokkos and MPI counterparts.
4646

47-
.. cpp:function:: void KokkosComm::initialize(int &argc, char ***argv)
47+
.. cpp:function:: void KokkosComm::initialize(int &argc, char *argv[], int mpi_required_thread_lvl)
48+
.. cpp:function:: void KokkosComm::initialize(int &argc, char *argv[])
4849

49-
Initializes the MPI execution environment with ``THREAD_MULTIPLE`` support, and then initializes the Kokkos execution environment. This function also strips ``--kokkos-help`` flags to prevent Kokkos from printing the help on all MPI ranks.
50+
Initializes the MPI execution environment with the required MPI thread level support (``MPI_THREAD_MULTIPLE`` if unspecified), and then initializes the Kokkos execution environment. This function also strips ``--kokkos-*`` flags to prevent Kokkos from printing them on all MPI ranks.
5051

5152
:param argc: Non-negative value representing the number of command-line arguments passed to the program.
52-
:param argv: Pointer to a pointer to the first element of an array of ``argc + 1`` pointers, of which the last one is null and the previous, if any, point to null-terminated multi-byte strings that represent the arguments passed to the program.
53+
:param argv: Pointer to the first element of an array of ``argc + 1`` pointers, of which the last one is null and the previous, if any, point to null-terminated multi-byte strings that represent the arguments passed to the program.
54+
:param mpi_required_thread_lvl: Level of desired MPI thread support.
5355

5456
**Requirements:**
5557

0 commit comments

Comments
 (0)