From: Wolfgang Bangerth Date: Tue, 7 Jan 2020 22:48:53 +0000 (-0700) Subject: Minor edits to the documentation of CommunicationPatternBase. X-Git-Tag: v9.2.0-rc1~717^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F9255%2Fhead;p=dealii.git Minor edits to the documentation of CommunicationPatternBase. --- diff --git a/include/deal.II/lac/communication_pattern_base.h b/include/deal.II/lac/communication_pattern_base.h index 39537f5c5b..25cf10669b 100644 --- a/include/deal.II/lac/communication_pattern_base.h +++ b/include/deal.II/lac/communication_pattern_base.h @@ -33,9 +33,9 @@ namespace LinearAlgebra * CommunicationPattern is an abstract class that is used to define a * communication plan that can be called repeatedly to efficiently obtain * off-processor elements. The idea is to decouple the communication pattern - * from the vectors. The goal is to reuse the same communication pattern for - * different vectors. This is similar to the way SparseMatrix and - * SparsityPattern works. + * from the data that needs to be communicated. The goal is to reuse the same + * communication pattern for different containers. + * This is similar to the way SparseMatrix and SparsityPattern works. * * @author Bruno Turcksin, 2015. */ @@ -48,10 +48,10 @@ namespace LinearAlgebra virtual ~CommunicationPatternBase() = default; /** - * Reinitialize the communication pattern. The first argument @p - * vector_space_vector_index_set is the index set associated to a - * VectorSpaceVector object. The second argument @p - * read_write_vector_index_set is the index set associated to a + * Reinitialize the communication pattern. The first argument + * `vector_space_vector_index_set` is the index set associated to a + * VectorSpaceVector object. The second argument + * `read_write_vector_index_set` is the index set associated to a * ReadWriteVector object. */ virtual void @@ -60,7 +60,7 @@ namespace LinearAlgebra const MPI_Comm &communicator) = 0; /** - * Return a constant reference to the underlying mpi communicator. + * Return a constant reference to the underlying MPI communicator. */ virtual const MPI_Comm & get_mpi_communicator() const = 0;