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

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

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

Public Member Functions

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

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::ConsensusAlgorithmSelector< T1, T2 >

A class which delegates its task to other ConsensusAlgorithm implementations depending on the number of processes in the MPI communicator. For a small number of processes it uses ConsensusAlgorithm_PEX and for large number of processes ConsensusAlgorithm_NBX. The threshold depends if the program is compiled in debug or release mode.

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 1358 of file mpi.h.

Constructor & Destructor Documentation

◆ ConsensusAlgorithmSelector()

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

Constructor.

Parameters
processProcess to be run during consensus algorithm.
commMPI Communicator.

Definition at line 1480 of file mpi.cc.

◆ ~ConsensusAlgorithmSelector()

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

Destructor.

Member Function Documentation

◆ run()

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

Run consensus algorithm.

Note
The function call is delegated to another ConsensusAlgorithm implementation.

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

Definition at line 1507 of file mpi.cc.


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