* 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.
*/
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
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;