]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document a restriction on ConsensusAlgorithms::serial(). 14389/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 2 Nov 2022 23:15:08 +0000 (17:15 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 2 Nov 2022 23:15:08 +0000 (17:15 -0600)
include/deal.II/base/mpi_consensus_algorithms.h

index 88cedfae5cebda3bd6aca2260220f5f5746c07f4..26a651daa5fa688e9ffc8a9c116b18acafe676f5 100644 (file)
@@ -877,7 +877,10 @@ namespace Utilities
        *   the caller of the consensus algorithm wants to do with the
        *   received answer.
        * @param[in] comm The MPI communicator on which the whole algorithm
-       *   is to be performed.
+       *   is to be performed. Since this function is supposed to be run
+       *   only for serial cases, the function throws an exception if
+       *   the provided communicator denotes an MPI universe with more
+       *   than one process.
        *
        * @tparam RequestType The type of the object to be sent.
        * @tparam AnswerType The type of the object to be received.
@@ -915,7 +918,10 @@ namespace Utilities
        *   rank of the process that has sent a request to us, along with
        *   the message of the request, and processes that message.
        * @param[in] comm The MPI communicator on which the whole algorithm
-       *   is to be performed.
+       *   is to be performed. Since this function is supposed to be run
+       *   only for serial cases, the function throws an exception if
+       *   the provided communicator denotes an MPI universe with more
+       *   than one process.
        *
        * @tparam RequestType The type of the object to be sent.
        */

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.