Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType > Class Template Reference

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

Inheritance diagram for Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >:

Public Member Functions
	Selector ()=default
	Selector (Process< RequestType, AnswerType > &process, const MPI_Comm &comm)
virtual	~Selector ()=default
virtual std::vector< unsigned int >	run (const std::vector< unsigned int > &targets, const std::function< RequestType(const unsigned int)> &create_request, const std::function< AnswerType(const unsigned int, const RequestType &)> &answer_request, const std::function< void(const unsigned int, const AnswerType &)> &process_answer, const MPI_Comm &comm) override
std::vector< unsigned int >	run ()
std::vector< unsigned int >	run (Process< RequestType, AnswerType > &process, const MPI_Comm &comm)

Private Attributes
std::shared_ptr< Interface< RequestType, AnswerType > >	consensus_algo
Process< RequestType, AnswerType > *	process
MPI_Comm	comm

Detailed Description

template<typename RequestType, typename AnswerType>
class Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >

A class which delegates its task to other ConsensusAlgorithms::Interface implementations depending on the number of processes in the MPI communicator. For a small number of processes it uses PEX and for a large number of processes NBX. The threshold depends if the program is compiled in debug or release mode, but the goal is to always use the most efficient algorithm for however many processes participate in the communication.

Template Parameters

RequestType	The type of the elements of the vector to be sent.
AnswerType	The type of the elements of the vector to be received.

Definition at line 945 of file mpi_consensus_algorithms.h.

Constructor & Destructor Documentation

Selector() [1/2]

template<typename RequestType , typename AnswerType >

Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >::Selector ( )

default

Default constructor.

Selector() [2/2]

template<typename RequestType , typename AnswerType >

Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >::Selector	(	Process< RequestType, AnswerType > &	process,
		const MPI_Comm &	comm
	)

Constructor.

Parameters

process	Process to be run during consensus algorithm.
comm	MPI Communicator.

Deprecated:

This constructor stores the Process object and the communicator so that one can later call the run() function without arguments. This approach is deprecated. Instead, use the default constructor of this class along with the run() function that takes an argument.

~Selector()

template<typename RequestType , typename AnswerType >

virtual Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >::~Selector ( )

virtualdefault

Destructor.

Member Function Documentation

run() [1/3]

template<typename RequestType , typename AnswerType >

virtual std::vector< unsigned int > Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >::run ( const std::vector< unsigned int > &  targets, const std::function< RequestType(const unsigned int)> &  create_request, const std::function< AnswerType(const unsigned int, const RequestType &)> &  answer_request, const std::function< void(const unsigned int, const AnswerType &)> &  process_answer, const MPI_Comm &  comm  )

overridevirtual

Run the consensus algorithm and return a vector of process ranks that have requested answers from the current process.

Deprecated:

This function is deprecated. It can be called if the Process object and communicator to be used have previously been provided to the non-default constructor. Use the run() functions taking arguments instead.

Note

The function call is delegated to another ConsensusAlgorithms::Interface implementation.

Implements Utilities::MPI::ConsensusAlgorithms::Interface< RequestType, AnswerType >.

run() [2/3]

template<typename RequestType , typename AnswerType >

std::vector< unsigned int > Utilities::MPI::ConsensusAlgorithms::Interface< RequestType, AnswerType >::run ( )

inherited

Run the consensus algorithm and return a vector of process ranks that have requested answers from the current process.

Deprecated:

This function is deprecated. It can be called if the Process object and communicator to be used have previously been provided to the non-default constructor. Use the run() functions taking arguments instead.

run() [3/3]

template<typename RequestType , typename AnswerType >

std::vector< unsigned int > Utilities::MPI::ConsensusAlgorithms::Interface< RequestType, AnswerType >::run ( Process< RequestType, AnswerType > &  process, const MPI_Comm &  comm  )

inherited

Run the consensus algorithm and return a vector of process ranks that have requested answers from the current process.

This version of the run() function simply unpacks the functions packaged in process and calls the version of the run() function that takes a number of std::function arguments.

Member Data Documentation

consensus_algo

template<typename RequestType , typename AnswerType >

std::shared_ptr<Interface<RequestType, AnswerType> > Utilities::MPI::ConsensusAlgorithms::Selector< RequestType, AnswerType >::consensus_algo

private

Definition at line 994 of file mpi_consensus_algorithms.h.

process

template<typename RequestType , typename AnswerType >

Process<RequestType, AnswerType>* Utilities::MPI::ConsensusAlgorithms::Interface< RequestType, AnswerType >::process

privateinherited

Reference to the process provided by the user.

This member variable is only used in the deprecated constructor and the run() function without argument. It is a nullptr otherwise

Definition at line 329 of file mpi_consensus_algorithms.h.

comm

template<typename RequestType , typename AnswerType >

MPI_Comm Utilities::MPI::ConsensusAlgorithms::Interface< RequestType, AnswerType >::comm

privateinherited

MPI communicator.

This member variable is only used in the deprecated constructor and the run() function without argument.

Definition at line 338 of file mpi_consensus_algorithms.h.

---

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

• include/deal.II/base/mpi_consensus_algorithms.h