Class TempLat::MPICommReference

ClassList > TempLat > MPICommReference

A class which holds an MPIComm. The Comm WILL DESTRUCT when the last owner of a reference to this class destructs its instance. Unless it is MPI_COMM_WORLD, of course. More...

• #include <mpicommreference.h>

Inherits the following classes: TempLat::MPIAllReduce

Public Functions

Type	Name
	MPICommReference (MPI_Comm comm=MPI_COMM_WORLD)
	MPICommReference (const MPICommReference & other) Copy constructor: must implement this for the bookkeeping.
int	getRank () const
	operator MPI_Comm () const
MPICommReference &	operator= (const MPICommReference & other) Copy assignment: must implement this for the bookkeeping.
int	rank () const
int	size () const
	~MPICommReference ()

Public Functions inherited from TempLat::MPIAllReduce

See TempLat::MPIAllReduce

Type	Name
const T &	Allreduce (const T & whatever, MPI_Op operation, ptrdiff_t size=1, int * error=nullptr) Dummy's for the MPI-less compilation.
T &	Allreduce (T * whatever, MPI_Op operation, int * error=nullptr) Dummy's for the MPI-less compilation.
	MPIAllReduce (MPI_Comm comm)
int	combineAllError (int error)
T	computeAllAnd (const T & value, size_t size=1, int * error=nullptr)
T	computeAllMax (const T & value, size_t size=1, int * error=nullptr)
T	computeAllMin (const T & value, size_t size=1, int * error=nullptr)
T	computeAllOr (const T & value, size_t size=1, int * error=nullptr)
T	computeAllSum (const T & value, size_t size=1, int * error=nullptr)

Public Static Functions

Type	Name
int	worldRank ()

Detailed Description

Unit test: ctest -R test-mpicommreference

Public Functions Documentation

function MPICommReference [1/2]

inline TempLat::MPICommReference::MPICommReference (
    MPI_Comm comm=MPI_COMM_WORLD
) 

---

function MPICommReference [2/2]

Copy constructor: must implement this for the bookkeeping.

inline TempLat::MPICommReference::MPICommReference (
    const MPICommReference & other
) 

---

function getRank

inline int TempLat::MPICommReference::getRank () const

---

function operator MPI_Comm

inline TempLat::MPICommReference::operator MPI_Comm () const

---

function operator=

Copy assignment: must implement this for the bookkeeping.

inline MPICommReference & TempLat::MPICommReference::operator= (
    const MPICommReference & other
) 

---

function rank

inline int TempLat::MPICommReference::rank () const

---

function size

inline int TempLat::MPICommReference::size () const

---

function ~MPICommReference

inline TempLat::MPICommReference::~MPICommReference () 

---

Public Static Functions Documentation

function worldRank

static inline int TempLat::MPICommReference::worldRank () 

---

---

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/parallel/mpi/comm/mpicommreference.h