Class TempLat::MPIAllReduce

ClassList > TempLat > MPIAllReduce

A class which calls MPI_Allreduce, meaning that all processes submit their value and receive the combined value of all processes, given an operation to combine the values. More...

• #include <mpiallreduce.h>

Inherited by the following classes: TempLat::MPICommReference

Public Functions

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)

Detailed Description

Unit test: ctest -R test-mpiallreduce

Public Functions Documentation

function Allreduce [1/2]

Dummy's for the MPI-less compilation.

template<typename T>
inline const T & TempLat::MPIAllReduce::Allreduce (
    const T & whatever,
    MPI_Op operation,
    ptrdiff_t size=1,
    int * error=nullptr
) 

---

function Allreduce [2/2]

Dummy's for the MPI-less compilation.

template<typename T>
inline T & TempLat::MPIAllReduce::Allreduce (
    T * whatever,
    MPI_Op operation,
    int * error=nullptr
) 

---

function MPIAllReduce

inline TempLat::MPIAllReduce::MPIAllReduce (
    MPI_Comm comm
) 

---

function combineAllError

inline int TempLat::MPIAllReduce::combineAllError (
    int error
) 

---

function computeAllAnd

template<typename T>
inline T TempLat::MPIAllReduce::computeAllAnd (
    const T & value,
    size_t size=1,
    int * error=nullptr
) 

---

function computeAllMax

template<typename T>
inline T TempLat::MPIAllReduce::computeAllMax (
    const T & value,
    size_t size=1,
    int * error=nullptr
) 

---

function computeAllMin

template<typename T>
inline T TempLat::MPIAllReduce::computeAllMin (
    const T & value,
    size_t size=1,
    int * error=nullptr
) 

---

function computeAllOr

template<typename T>
inline T TempLat::MPIAllReduce::computeAllOr (
    const T & value,
    size_t size=1,
    int * error=nullptr
) 

---

function computeAllSum

template<typename T>
inline T TempLat::MPIAllReduce::computeAllSum (
    const T & value,
    size_t size=1,
    int * error=nullptr
) 

---

---

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