Teuchos::MPIComm Class Reference

Object representation of an MPI communicator. More...

#include <Teuchos_MPIComm.hpp>

List of all members.

Public Member Functions
	MPIComm ()
	Empty constructor builds an object for MPI_COMM_WORLD.
int	getRank () const
	Return process rank.
int	getNProc () const
	Return number of processors in the communicator.
void	synchronize () const
	Synchronize all the processors in the communicator.
Collective communications
void	allToAll (void *sendBuf, int sendCount, int sendType, void *recvBuf, int recvCount, int recvType) const
	All-to-all gather-scatter.
void	allToAllv (void *sendBuf, int *sendCount, int *sendDisplacements, int sendType, void *recvBuf, int *recvCount, int *recvDisplacements, int recvType) const
	Variable-length gather-scatter.
void	allReduce (void *input, void *result, int inputCount, int type, int op) const
	Do a collective operation, scattering the results to all processors.
void	gather (void *sendBuf, int sendCount, int sendType, void *recvBuf, int recvCount, int recvType, int root) const
	Gather to root.
void	gatherv (void *sendBuf, int sendCount, int sendType, void *recvBuf, int *recvCount, int *displacements, int recvType, int root) const
	Gather variable-sized arrays to root.
void	allGather (void *sendBuf, int sendCount, int sendType, void *recvBuf, int recvCount, int recvType) const
	Gather to all processors.
void	allGatherv (void *sendBuf, int sendCount, int sendType, void *recvBuf, int *recvCount, int *recvDisplacements, int recvType) const
	Variable-length gather to all processors.
void	bcast (void *msg, int length, int type, int src) const
	Broadcast.
Static Public Member Functions
MPIComm &	world ()
	Get an object representing MPI_COMM_WORLD.
Static Public Attributes
Data types
const int	INT = 1
	Integer data type.
const int	FLOAT = 2
	Float data type.
const int	DOUBLE = 3
	Double data type.
const int	CHAR = 4
	Character data type.
Operations
const int	SUM = 5
	Summation operation.
const int	MIN = 6
	Minimize operation.
const int	MAX = 7
	Maximize operation.
const int	PROD = 8
	Dot-product (Multiplication) operation.

---

Detailed Description

Object representation of an MPI communicator.

At present, groups are not implemented so the only communicator is MPI_COMM_WORLD.

---

Constructor & Destructor Documentation

MPIComm::MPIComm (   )

Empty constructor builds an object for MPI_COMM_WORLD.

---

Member Function Documentation

MPIComm & MPIComm::world (   )  [static]

Get an object representing MPI_COMM_WORLD.

int Teuchos::MPIComm::getRank (   )  const [inline]

Return process rank.

int Teuchos::MPIComm::getNProc (   )  const [inline]

Return number of processors in the communicator.

void MPIComm::synchronize (   )  const

Synchronize all the processors in the communicator.

void MPIComm::allToAll (  void *  sendBuf, int  sendCount, int  sendType, void *  recvBuf, int  recvCount, int  recvType )  const

All-to-all gather-scatter.

void MPIComm::allToAllv (  void *  sendBuf, int *  sendCount, int *  sendDisplacements, int  sendType, void *  recvBuf, int *  recvCount, int *  recvDisplacements, int  recvType )  const

Variable-length gather-scatter.

void MPIComm::allReduce (  void *  input, void *  result, int  inputCount, int  type, int  op )  const

Do a collective operation, scattering the results to all processors.

void MPIComm::gather (  void *  sendBuf, int  sendCount, int  sendType, void *  recvBuf, int  recvCount, int  recvType, int  root )  const

Gather to root.

void MPIComm::gatherv (  void *  sendBuf, int  sendCount, int  sendType, void *  recvBuf, int *  recvCount, int *  displacements, int  recvType, int  root )  const

Gather variable-sized arrays to root.

void MPIComm::allGather (  void *  sendBuf, int  sendCount, int  sendType, void *  recvBuf, int  recvCount, int  recvType )  const

Gather to all processors.

void MPIComm::allGatherv (  void *  sendBuf, int  sendCount, int  sendType, void *  recvBuf, int *  recvCount, int *  recvDisplacements, int  recvType )  const

Variable-length gather to all processors.

void MPIComm::bcast (  void *  msg, int  length, int  type, int  src )  const

Broadcast.

---

Member Data Documentation

const int Teuchos::MPIComm::INT = 1 [static]

Integer data type.

const int Teuchos::MPIComm::FLOAT = 2 [static]

Float data type.

const int Teuchos::MPIComm::DOUBLE = 3 [static]

Double data type.

const int Teuchos::MPIComm::CHAR = 4 [static]

Character data type.

const int Teuchos::MPIComm::SUM = 5 [static]

Summation operation.

const int Teuchos::MPIComm::MIN = 6 [static]

Minimize operation.

const int Teuchos::MPIComm::MAX = 7 [static]

Maximize operation.

const int Teuchos::MPIComm::PROD = 8 [static]

Dot-product (Multiplication) operation.

---

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

• Teuchos_MPIComm.hpp
• Teuchos_MPIComm.cpp

---