Reference documentation for deal.II version Git ae22ce0c2c 2019-12-09 21:30:56 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 > Class Template Reference

#include <deal.II/base/mpi.h>

Inheritance diagram for Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >:
[legend]

Public Member Functions

 ConsensusAlgorithm_NBX (ConsensusAlgorithmProcess< T1, T2 > &process, const MPI_Comm &comm)
 
virtual ~ConsensusAlgorithm_NBX ()=default
 
virtual void run () override
 
- Public Member Functions inherited from Utilities::MPI::ConsensusAlgorithm< T1, T2 >
virtual ~ConsensusAlgorithm ()=default
 

Private Member Functions

bool check_own_state ()
 
void signal_finish ()
 
bool check_global_state ()
 
void process_requests ()
 
void start_communication ()
 
void clean_up_and_end_communication ()
 

Private Attributes

std::vector< unsigned int > targets
 
std::vector< std::vector< T1 > > send_buffers
 
std::vector< MPI_Request > send_requests
 
std::vector< std::vector< T2 > > recv_buffers
 
std::vector< MPI_Request > recv_requests
 
std::vector< std::unique_ptr< std::vector< T2 > > > request_buffers
 
std::vector< std::unique_ptr< MPI_Request > > request_requests
 
std::set< unsigned int > requesting_processes
 

Additional Inherited Members

- Protected Attributes inherited from Utilities::MPI::ConsensusAlgorithm< T1, T2 >
ConsensusAlgorithmProcess< T1, T2 > & process
 
const MPI_Comm & comm
 
const unsigned int my_rank
 
const unsigned int n_procs
 

Detailed Description

template<typename T1, typename T2>
class Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >

This class implements ConsensusAlgorithm, using only point-to-point communications and a single IBarrier.

Note
This class closely follows the paper Hoefler, Siebert, Lumsdaine "Scalable Communication Protocols for Dynamic Sparse Data Exchange". Since the algorithm shown there is not considering payloads, the algorithm has been modified here in such a way that synchronous sends (Issend) have been replaced by equivalent Isend/Irecv, where Irecv receives the answer to a request (with payload).
Template Parameters
T1the type of the elements of the vector to sent
T2the type of the elements of the vector to received
Author
Peter Munch, 2019

Definition at line 1121 of file mpi.h.

Constructor & Destructor Documentation

◆ ConsensusAlgorithm_NBX()

template<typename T1 , typename T2 >
Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::ConsensusAlgorithm_NBX ( ConsensusAlgorithmProcess< T1, T2 > &  process,
const MPI_Comm &  comm 
)

Constructor.

Parameters
processProcess to be run during consensus algorithm.
commMPI Communicator

Definition at line 1017 of file mpi.cc.

◆ ~ConsensusAlgorithm_NBX()

template<typename T1 , typename T2 >
virtual Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::~ConsensusAlgorithm_NBX ( )
virtualdefault

Destructor.

Member Function Documentation

◆ run()

template<typename T1 , typename T2 >
void Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::run ( )
overridevirtual

Run consensus algorithm.

Implements Utilities::MPI::ConsensusAlgorithm< T1, T2 >.

Definition at line 1027 of file mpi.cc.

◆ check_own_state()

template<typename T1 , typename T2 >
bool Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::check_own_state ( )
private

Check if all request answers have been received by this rank.

Definition at line 1058 of file mpi.cc.

◆ signal_finish()

template<typename T1 , typename T2 >
void Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::signal_finish ( )
private

Signal to all other ranks that this rank has received all request answers via entering IBarrier.

Definition at line 1078 of file mpi.cc.

◆ check_global_state()

template<typename T1 , typename T2 >
bool Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::check_global_state ( )
private

Check if all ranks have received all their request answers, i.e. all ranks have reached the IBarrier.

Definition at line 1097 of file mpi.cc.

◆ process_requests()

template<typename T1 , typename T2 >
void Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::process_requests ( )
private

A request message from another rank has been received: process the request and send an answer.

Definition at line 1115 of file mpi.cc.

◆ start_communication()

template<typename T1 , typename T2 >
void Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::start_communication ( )
private

Start to send all requests via ISend and post IRecvs for the incoming answer messages.

Definition at line 1189 of file mpi.cc.

◆ clean_up_and_end_communication()

template<typename T1 , typename T2 >
void Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::clean_up_and_end_communication ( )
private

After all rank has received all answers, the MPI data structures can be freed and the received answers can be processed.

Definition at line 1248 of file mpi.cc.

Member Data Documentation

◆ targets

template<typename T1 , typename T2 >
std::vector<unsigned int> Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::targets
private

List of processes this process wants to send requests to.

Definition at line 1149 of file mpi.h.

◆ send_buffers

template<typename T1 , typename T2 >
std::vector<std::vector<T1> > Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::send_buffers
private

Buffers for sending requests.

Definition at line 1154 of file mpi.h.

◆ send_requests

template<typename T1 , typename T2 >
std::vector<MPI_Request> Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::send_requests
private

Requests for sending requests.

Definition at line 1159 of file mpi.h.

◆ recv_buffers

template<typename T1 , typename T2 >
std::vector<std::vector<T2> > Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::recv_buffers
private

Buffers for receiving answers to requests.

Definition at line 1164 of file mpi.h.

◆ recv_requests

template<typename T1 , typename T2 >
std::vector<MPI_Request> Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::recv_requests
private

Requests for receiving answers to requests.

Definition at line 1170 of file mpi.h.

◆ request_buffers

template<typename T1 , typename T2 >
std::vector<std::unique_ptr<std::vector<T2> > > Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::request_buffers
private

Buffers for sending answers to requests.

Definition at line 1175 of file mpi.h.

◆ request_requests

template<typename T1 , typename T2 >
std::vector<std::unique_ptr<MPI_Request> > Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::request_requests
private

Requests for sending answers to requests.

Definition at line 1180 of file mpi.h.

◆ requesting_processes

template<typename T1 , typename T2 >
std::set<unsigned int> Utilities::MPI::ConsensusAlgorithm_NBX< T1, T2 >::requesting_processes
private

List of processes who have made a request to this process.

Definition at line 1190 of file mpi.h.


The documentation for this class was generated from the following files: