vf::parallel::Communicator Class Reference

An abstract class for communication between processes in parallel computation. More...

#include <Communicator.h>

Inheritance diagram for vf::parallel::Communicator:

Public Member Functions
	Communicator (const Communicator &)=delete
Communicator &	operator= (const Communicator &rhs)=delete
virtual	~Communicator ()=default
virtual double	Wtime ()=0
virtual int	getBundleID () const =0
virtual int	getNumberOfBundles () const =0
virtual int	getProcessID () const =0
virtual int	getProcessID (int bundle, int rank) const =0
virtual bool	isRoot () const =0
virtual void *	getNativeCommunicator ()=0
virtual void	sendSerializedObject (std::stringstream &ss, int target)=0
virtual void	receiveSerializedObject (std::stringstream &ss, int source)=0
virtual int	getRoot () const =0
virtual int	getBundleRoot () const =0
virtual int	getProcessRoot () const =0
virtual int	getNumberOfProcessesInBundle (int bundle) const =0
virtual void	barrier ()=0
virtual void	abort (int errorcode)=0
virtual std::vector< std::string >	gather (const std::string &str)=0
virtual std::vector< int >	gather (std::vector< int > &values)=0
virtual std::vector< float >	gather (std::vector< float > &values)=0
virtual std::vector< double >	gather (std::vector< double > &values)=0
virtual std::vector< unsigned long long >	gather (std::vector< unsigned long long > &values)=0
virtual void	allGather (std::vector< int > &svalues, std::vector< int > &rvalues)=0
virtual void	allGather (std::vector< float > &svalues, std::vector< float > &rvalues)=0
virtual void	allGather (std::vector< double > &svalues, std::vector< double > &rvalues)=0
virtual void	allGather (std::vector< unsigned long long > &svalues, std::vector< unsigned long long > &rvalues)=0
virtual void	allGather (std::vector< uint > &svalues, std::vector< uint > &rvalues)=0
virtual void	allReduceSum (std::vector< float > &svalues)=0
virtual void	allReduceSum (std::vector< double > &svalues)=0
virtual void	allReduceSum (std::vector< uint > &svalues)=0
virtual void	broadcast (int &value)=0
virtual void	broadcast (float &value)=0
virtual void	broadcast (double &value)=0
virtual void	broadcast (long int &value)=0
virtual void	broadcast (std::vector< int > &values)=0
virtual void	broadcast (std::vector< float > &values)=0
virtual void	broadcast (std::vector< double > &values)=0
virtual void	broadcast (std::vector< long int > &values)=0
virtual void	receiveSend (uint *buffer_receive, int size_buffer_recv, int neighbor_rank_recv, const uint *buffer_send, int size_buffer_send, int neighbor_rank_send) const =0
virtual int	getNumberOfProcesses () const =0
virtual void	send (real *sbuf, int count_s, int nb_rank) const =0
virtual double	reduceSum (double quantityPerProcess) const =0
virtual int	mapCudaDevicesOnHosts (const std::vector< unsigned int > &devices, int numberOfDevices) const =0
virtual void	receiveSend (real *buffer_send, int size_buffer_send, real *buffer_receive, int size_buffer_recv, int neighbor_rank) const =0
virtual void	receiveNonBlocking (real *rbuf, int count_r, int sourceRank)=0
virtual void	sendNonBlocking (real *sbuf, int count_s, int destinationRank)=0
virtual void	send (real *sbuf, int count_s, int destinationRank)=0
virtual void	waitAll ()=0
virtual void	resetRequests ()=0

Static Public Member Functions
static std::shared_ptr< Communicator >	getInstance ()

Protected Member Functions
	Communicator ()=default

Static Protected Attributes
static std::mutex	instantiation_mutex = std::mutex()
static std::shared_ptr< Communicator >	instance = std::shared_ptr<Communicator>()

Detailed Description

An abstract class for communication between processes in parallel computation.

Definition at line 49 of file Communicator.h.

Constructor & Destructor Documentation

Communicator() [1/2]

vf::parallel::Communicator::Communicator ( const Communicator &  )

delete

~Communicator()

virtual vf::parallel::Communicator::~Communicator ( )

virtualdefault

Communicator() [2/2]

vf::parallel::Communicator::Communicator ( )

protecteddefault

Member Function Documentation

abort()

virtual void vf::parallel::Communicator::abort ( int  errorcode )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allGather() [1/5]

virtual void vf::parallel::Communicator::allGather ( std::vector< double > &  svalues, std::vector< double > &  rvalues  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allGather() [2/5]

virtual void vf::parallel::Communicator::allGather ( std::vector< float > &  svalues, std::vector< float > &  rvalues  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allGather() [3/5]

virtual void vf::parallel::Communicator::allGather ( std::vector< int > &  svalues, std::vector< int > &  rvalues  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allGather() [4/5]

virtual void vf::parallel::Communicator::allGather ( std::vector< uint > &  svalues, std::vector< uint > &  rvalues  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allGather() [5/5]

virtual void vf::parallel::Communicator::allGather ( std::vector< unsigned long long > &  svalues, std::vector< unsigned long long > &  rvalues  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allReduceSum() [1/3]

virtual void vf::parallel::Communicator::allReduceSum ( std::vector< double > &  svalues )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allReduceSum() [2/3]

virtual void vf::parallel::Communicator::allReduceSum ( std::vector< float > &  svalues )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

allReduceSum() [3/3]

virtual void vf::parallel::Communicator::allReduceSum ( std::vector< uint > &  svalues )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

barrier()

virtual void vf::parallel::Communicator::barrier ( )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [1/8]

virtual void vf::parallel::Communicator::broadcast ( double &  value )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [2/8]

virtual void vf::parallel::Communicator::broadcast ( float &  value )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [3/8]

virtual void vf::parallel::Communicator::broadcast ( int &  value )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [4/8]

virtual void vf::parallel::Communicator::broadcast ( long int &  value )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [5/8]

virtual void vf::parallel::Communicator::broadcast ( std::vector< double > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [6/8]

virtual void vf::parallel::Communicator::broadcast ( std::vector< float > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [7/8]

virtual void vf::parallel::Communicator::broadcast ( std::vector< int > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

broadcast() [8/8]

virtual void vf::parallel::Communicator::broadcast ( std::vector< long int > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

gather() [1/5]

virtual std::vector< std::string > vf::parallel::Communicator::gather ( const std::string &  str )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

gather() [2/5]

virtual std::vector< double > vf::parallel::Communicator::gather ( std::vector< double > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

gather() [3/5]

virtual std::vector< float > vf::parallel::Communicator::gather ( std::vector< float > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

gather() [4/5]

virtual std::vector< int > vf::parallel::Communicator::gather ( std::vector< int > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

gather() [5/5]

virtual std::vector< unsigned long long > vf::parallel::Communicator::gather ( std::vector< unsigned long long > &  values )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getBundleID()

virtual int vf::parallel::Communicator::getBundleID ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getBundleRoot()

virtual int vf::parallel::Communicator::getBundleRoot ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getInstance()

std::shared_ptr< Communicator > vf::parallel::Communicator::getInstance ( )

static

Definition at line 42 of file Communicator.cpp.

getNativeCommunicator()

virtual void * vf::parallel::Communicator::getNativeCommunicator ( )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getNumberOfBundles()

virtual int vf::parallel::Communicator::getNumberOfBundles ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getNumberOfProcesses()

virtual int vf::parallel::Communicator::getNumberOfProcesses ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getNumberOfProcessesInBundle()

virtual int vf::parallel::Communicator::getNumberOfProcessesInBundle ( int  bundle ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getProcessID() [1/2]

virtual int vf::parallel::Communicator::getProcessID ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getProcessID() [2/2]

virtual int vf::parallel::Communicator::getProcessID ( int  bundle, int  rank  ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getProcessRoot()

virtual int vf::parallel::Communicator::getProcessRoot ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

getRoot()

virtual int vf::parallel::Communicator::getRoot ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

isRoot()

virtual bool vf::parallel::Communicator::isRoot ( ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

mapCudaDevicesOnHosts()

virtual int vf::parallel::Communicator::mapCudaDevicesOnHosts ( const std::vector< unsigned int > &  devices, int  numberOfDevices  ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

operator=()

Communicator & vf::parallel::Communicator::operator= ( const Communicator &  rhs )

delete

receiveNonBlocking()

virtual void vf::parallel::Communicator::receiveNonBlocking ( real *  rbuf, int  count_r, int  sourceRank  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

receiveSend() [1/2]

virtual void vf::parallel::Communicator::receiveSend ( real *  buffer_send, int  size_buffer_send, real *  buffer_receive, int  size_buffer_recv, int  neighbor_rank  ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, vf::parallel::NullCommunicator, and vf::gpu::CommunicatorDouble.

receiveSend() [2/2]

virtual void vf::parallel::Communicator::receiveSend ( uint *  buffer_receive, int  size_buffer_recv, int  neighbor_rank_recv, const uint *  buffer_send, int  size_buffer_send, int  neighbor_rank_send  ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, vf::parallel::NullCommunicator, and vf::gpu::CommunicatorDouble.

receiveSerializedObject()

virtual void vf::parallel::Communicator::receiveSerializedObject ( std::stringstream &  ss, int  source  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

reduceSum()

virtual double vf::parallel::Communicator::reduceSum ( double  quantityPerProcess ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

resetRequests()

virtual void vf::parallel::Communicator::resetRequests ( )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

send() [1/2]

virtual void vf::parallel::Communicator::send ( real *  sbuf, int  count_s, int  destinationRank  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

send() [2/2]

virtual void vf::parallel::Communicator::send ( real *  sbuf, int  count_s, int  nb_rank  ) const

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

sendNonBlocking()

virtual void vf::parallel::Communicator::sendNonBlocking ( real *  sbuf, int  count_s, int  destinationRank  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

sendSerializedObject()

virtual void vf::parallel::Communicator::sendSerializedObject ( std::stringstream &  ss, int  target  )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

waitAll()

virtual void vf::parallel::Communicator::waitAll ( )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

Wtime()

virtual double vf::parallel::Communicator::Wtime ( )

pure virtual

Implemented in vf::parallel::MPICommunicator, and vf::parallel::NullCommunicator.

Member Data Documentation

instance

std::shared_ptr< Communicator > vf::parallel::Communicator::instance = std::shared_ptr<Communicator>()

staticprotected

Definition at line 121 of file Communicator.h.

instantiation_mutex

std::mutex vf::parallel::Communicator::instantiation_mutex = std::mutex()

staticprotected

Definition at line 119 of file Communicator.h.

---

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

• src/parallel/Communicator.h
• src/parallel/Communicator.cpp