From: Wolfgang Bangerth Date: Wed, 2 Nov 2022 23:15:08 +0000 (-0600) Subject: Document a restriction on ConsensusAlgorithms::serial(). X-Git-Tag: v9.5.0-rc1~882^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F14389%2Fhead;p=dealii.git Document a restriction on ConsensusAlgorithms::serial(). --- diff --git a/include/deal.II/base/mpi_consensus_algorithms.h b/include/deal.II/base/mpi_consensus_algorithms.h index 88cedfae5c..26a651daa5 100644 --- a/include/deal.II/base/mpi_consensus_algorithms.h +++ b/include/deal.II/base/mpi_consensus_algorithms.h @@ -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. */