Skip to content

Commit 3f2eb23

Browse files
authored
Update t8_cmesh_comm_is_valid documantation
1 parent bd6a0ef commit 3f2eb23

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

src/t8_cmesh.h

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -468,12 +468,10 @@ t8_cmesh_t
468468
t8_cmesh_load_and_distribute (const char *fileprefix, int num_files, sc_MPI_Comm comm, t8_load_mode_t mode,
469469
int procs_per_node);
470470

471-
/** Check whether a given MPI communicator assigns the same rank and mpisize
472-
* as stored in a cmesh.
471+
/** Check whether a given MPI communicator matches the cmesh communicator.
473472
* \param [in] cmesh The cmesh to be considered.
474473
* \param [in] comm A MPI communicator.
475-
* \return True if mpirank and mpisize from \a comm are the same as
476-
* the values stored in \a cmesh.
474+
* \return True if \a comm is the communicator \a cmesh was commited with.
477475
* False otherwise.
478476
* \a cmesh must be committed before calling this function.
479477
* */

0 commit comments

Comments
 (0)