Dune::CollectiveCommunication< MPI_Comm > Class Template Reference
[Parallel Communication]
#include <mpicollectivecommunication.hh>
Detailed Description
template<>
class Dune::CollectiveCommunication< MPI_Comm >
Specialization of CollectiveCommunication for MPI. Public Member Functions | |
CollectiveCommunication (const MPI_Comm &c) | |
Instantiation using a MPI communicator. | |
int | rank () const |
int | size () const |
template<typename T> | |
T | sum (T &in) const |
template<typename T> | |
int | sum (T *inout, int len) const |
template<typename T> | |
T | prod (T &in) const |
template<typename T> | |
int | prod (T *inout, int len) const |
template<typename T> | |
T | min (T &in) const |
template<typename T> | |
int | min (T *inout, int len) const |
template<typename T> | |
T | max (T &in) const |
template<typename T> | |
int | max (T *inout, int len) const |
int | barrier () const |
template<typename T> | |
int | broadcast (T *inout, int len, int root) const |
template<typename T> | |
int | gather (T *in, T *out, int len, int root) const |
Member Function Documentation
int Dune::CollectiveCommunication< MPI_Comm >::rank | ( | ) | const [inline] |
Return rank, is between 0 and size()-1.
int Dune::CollectiveCommunication< MPI_Comm >::size | ( | ) | const [inline] |
Number of processes in set, is greater than 0.
template<typename T>
T Dune::CollectiveCommunication< MPI_Comm >::sum | ( | T & | in | ) | const [inline] |
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::sum | ( | T * | inout, | |
int | len | |||
) | const [inline] |
template<typename T>
T Dune::CollectiveCommunication< MPI_Comm >::prod | ( | T & | in | ) | const [inline] |
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::prod | ( | T * | inout, | |
int | len | |||
) | const [inline] |
template<typename T>
T Dune::CollectiveCommunication< MPI_Comm >::min | ( | T & | in | ) | const [inline] |
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::min | ( | T * | inout, | |
int | len | |||
) | const [inline] |
template<typename T>
T Dune::CollectiveCommunication< MPI_Comm >::max | ( | T & | in | ) | const [inline] |
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::max | ( | T * | inout, | |
int | len | |||
) | const [inline] |
int Dune::CollectiveCommunication< MPI_Comm >::barrier | ( | ) | const [inline] |
Wait until all processes have arrived at this point in the program.
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::broadcast | ( | T * | inout, | |
int | len, | |||
int | root | |||
) | const [inline] |
Distribute an array from the process with rank root to all other processes.
template<typename T>
int Dune::CollectiveCommunication< MPI_Comm >::gather | ( | T * | in, | |
T * | out, | |||
int | len, | |||
int | root | |||
) | const [inline] |
The documentation for this class was generated from the following file: