1 // --------------------------------------------------------------------- 2 // 3 // Copyright (C) 2015 - 2020 by the deal.II authors 4 // 5 // This file is part of the deal.II library. 6 // 7 // The deal.II library is free software; you can use it, redistribute 8 // it, and/or modify it under the terms of the GNU Lesser General 9 // Public License as published by the Free Software Foundation; either 10 // version 2.1 of the License, or (at your option) any later version. 11 // The full text of the license can be found in the file LICENSE.md at 12 // the top level directory of deal.II. 13 // 14 // --------------------------------------------------------------------- 15 16 #ifndef dealii_communication_pattern_base_h 17 #define dealii_communication_pattern_base_h 18 19 #include <deal.II/base/config.h> 20 21 #include <deal.II/base/mpi.h> 22 23 DEAL_II_NAMESPACE_OPEN 24 25 // Forward declaration 26 #ifndef DOXYGEN 27 class IndexSet; 28 #endif 29 30 namespace LinearAlgebra 31 { 32 /** 33 * CommunicationPattern is an abstract class that is used to define a 34 * communication plan that can be called repeatedly to efficiently obtain 35 * off-processor elements. The idea is to decouple the communication pattern 36 * from the data that needs to be communicated. The goal is to reuse the same 37 * communication pattern for different containers. 38 * This is similar to the way SparseMatrix and SparsityPattern works. 39 */ 40 class CommunicationPatternBase 41 { 42 public: 43 /** 44 * Destructor. 45 */ 46 virtual ~CommunicationPatternBase() = default; 47 48 /** 49 * Reinitialize the communication pattern. The first argument 50 * `vector_space_vector_index_set` is the index set associated to a 51 * VectorSpaceVector object. The second argument 52 * `read_write_vector_index_set` is the index set associated to a 53 * ReadWriteVector object. 54 */ 55 virtual void 56 reinit(const IndexSet &vector_space_vector_index_set, 57 const IndexSet &read_write_vector_index_set, 58 const MPI_Comm &communicator) = 0; 59 60 /** 61 * Return a constant reference to the underlying MPI communicator. 62 */ 63 virtual const MPI_Comm & 64 get_mpi_communicator() const = 0; 65 }; 66 67 } // end of namespace LinearAlgebra 68 69 DEAL_II_NAMESPACE_CLOSE 70 71 #endif 72