Main Page Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members File Members Related Pages Examples

Sundance::MPIComm Class Reference

#include <MPIComm.h>

List of all members.

Public Methods

MPIComm ()
empty ctor builds an object for MPI_COMM_WORLD
MPIComm (MPI_Comm comm)
construct a MPIComm for a given MPI communicator
void init ()
common initialization function, called by all ctors
int getRank () const
return process rank
int getNProc () const
return number of processors in the communicator
string getMachineName () const
get the name of the machine on which this process is running
void synchronize () const
synchronize all the processors in the communicator
MPI_Comm getComm () const
get the MPI_Comm communicator handle
MPI_Request * getRequestTSFArray () const
MPI_Request getRequest (int pid) const
void setRequest (int pid, MPI_Request req) const

Point to point communications

void send (void *msg, int length, int type, int tag, int dest) const
blocking send
int recv (void *msg, int length, int type, int tag, int src) const
blocking recv
int irecv (void *msg, int length, int type, int tag, int src) const
non-blocking recv
void disableIrecv (int proc) const
shut off a pending irecv
void wait (int handler) const
int testAny () const
int waitAny () const
void bcast (void *msg, int length, int type, int src) const

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 procs
void gather (void *sendBuf, int sendCount, int sendType, void *recvBuf, int recvCount, int recvType, int root) const
gather to root
void allGather (void *sendBuf, int sendCount, int sendType, void *recvBuf, int recvCount, int recvType) const
gather to all procs
void allGatherv (void *sendBuf, int sendCount, int sendType, void *recvBuf, int *recvCount, int *recvDisplacements, int recvType) const
gather to all procs

Static Public Methods

MPIComm & world ()
get an object representing MPI_COMM_WORLD
void init (int *argc, void ***argv)
call MPI_Init
void finalize ()
call MPI_Finalize
void errCheck (int errCode, const string &methodName)
MPI_Datatype getDataType (int type)
MPI_Op getOp (int op)

Static Public Attributes

Data types

const int INT
const int FLOAT
const int DOUBLE
const int CHAR

Operations

const int SUM
const int MIN
const int MAX
const int PROD

Private Attributes

MPI_Comm comm_
TSFSmartPtr< TSFArray< MPI_Request > > req_
int nProc_
int myRank_

Static Private Attributes

string machineName_

Detailed Description

Object representation of an MPI communicator.

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

Definition at line 26 of file MPIComm.h.

Constructor & Destructor Documentation

Sundance::MPIComm::MPIComm ( )

Sundance::MPIComm::MPIComm ( MPI_Comm comm )

Member Function Documentation

MPIComm& Sundance::MPIComm::world ( ) [static]

void Sundance::MPIComm::init ( )

void Sundance::MPIComm::init ( int * argc,

void *** argv

) [static]

void Sundance::MPIComm::finalize ( ) [static]

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

Definition at line 58 of file MPIComm.h.
References myRank_.
Referenced by Sundance::ContainerComm< string >::bcast(), and Sundance::ContainerComm< T >::bcast().

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

Definition at line 61 of file MPIComm.h.
References nProc_.
Referenced by Sundance::ContainerComm< T >::accumulate(), Sundance::ContainerComm< string >::allGather(), Sundance::ContainerComm< T >::allGather(), and Sundance::ContainerComm< T >::allToAll().

string Sundance::MPIComm::getMachineName ( ) const

void Sundance::MPIComm::synchronize ( ) const

void Sundance::MPIComm::send ( void * msg,

int length,

int type,

int tag,

int dest

) const

Referenced by Sundance::ContainerComm< string >::send(), and Sundance::ContainerComm< T >::send().

int Sundance::MPIComm::recv ( void * msg,

int length,

int type,

int tag,

int src

) const

Referenced by Sundance::ContainerComm< string >::recv(), and Sundance::ContainerComm< T >::recv().

int Sundance::MPIComm::irecv ( void * msg,

int length,

int type,

int tag,

int src

) const

void Sundance::MPIComm::disableIrecv ( int proc ) const

void Sundance::MPIComm::wait ( int handler ) const

int Sundance::MPIComm::testAny ( ) const

int Sundance::MPIComm::waitAny ( ) const

void Sundance::MPIComm::bcast ( void * msg,

int length,

int type,

int src

) const

Referenced by Sundance::ContainerComm< string >::bcast(), and Sundance::ContainerComm< T >::bcast().

void Sundance::MPIComm::allToAll ( void * sendBuf,

int sendCount,

int sendType,

void * recvBuf,

int recvCount,

int recvType

) const

Referenced by Sundance::ContainerComm< T >::allToAll().

void Sundance::MPIComm::allToAllv ( void * sendBuf,

int * sendCount,

int * sendDisplacements,

int sendType,

void * recvBuf,

int * recvCount,

int * recvDisplacements,

int recvType

) const

Referenced by Sundance::ContainerComm< T >::allToAll().

void Sundance::MPIComm::allReduce ( void * input,

void * result,

int inputCount,

int type,

int op

) const

void Sundance::MPIComm::gather ( void * sendBuf,

int sendCount,

int sendType,

void * recvBuf,

int recvCount,

int recvType,

int root

) const

void Sundance::MPIComm::allGather ( void * sendBuf,

int sendCount,

int sendType,

void * recvBuf,

int recvCount,

int recvType

) const

Referenced by Sundance::ContainerComm< string >::allGather(), and Sundance::ContainerComm< T >::allGather().

void Sundance::MPIComm::allGatherv ( void * sendBuf,

int sendCount,

int sendType,

void * recvBuf,

int * recvCount,

int * recvDisplacements,

int recvType

) const

Referenced by Sundance::ContainerComm< string >::allGather().

MPI_Comm Sundance::MPIComm::getComm ( ) const [inline]

Definition at line 120 of file MPIComm.h.
References comm_.

MPI_Request* Sundance::MPIComm::getRequestTSFArray ( ) const [inline]

Definition at line 123 of file MPIComm.h.

MPI_Request Sundance::MPIComm::getRequest ( int pid ) const [inline]

Definition at line 124 of file MPIComm.h.

void Sundance::MPIComm::setRequest ( int pid,

MPI_Request req

) const [inline]

Definition at line 125 of file MPIComm.h.

void Sundance::MPIComm::errCheck ( int errCode,

const string & methodName

) [static]

MPI_Datatype Sundance::MPIComm::getDataType ( int type ) [static]

MPI_Op Sundance::MPIComm::getOp ( int op ) [static]

Member Data Documentation

const int Sundance::MPIComm::INT [static]

Definition at line 133 of file MPIComm.h.

const int Sundance::MPIComm::FLOAT [static]

Definition at line 135 of file MPIComm.h.

const int Sundance::MPIComm::DOUBLE [static]

Definition at line 137 of file MPIComm.h.

const int Sundance::MPIComm::CHAR [static]

Definition at line 139 of file MPIComm.h.

const int Sundance::MPIComm::SUM [static]

Definition at line 145 of file MPIComm.h.

const int Sundance::MPIComm::MIN [static]

Definition at line 147 of file MPIComm.h.

const int Sundance::MPIComm::MAX [static]

Definition at line 149 of file MPIComm.h.

const int Sundance::MPIComm::PROD [static]

Definition at line 151 of file MPIComm.h.

MPI_Comm Sundance::MPIComm::comm_ [private]

Definition at line 168 of file MPIComm.h.
Referenced by getComm().

TSFSmartPtr<TSFArray<MPI_Request> > Sundance::MPIComm::req_ [private]

Definition at line 169 of file MPIComm.h.

int Sundance::MPIComm::nProc_ [private]

Definition at line 172 of file MPIComm.h.
Referenced by getNProc().

int Sundance::MPIComm::myRank_ [private]

Definition at line 173 of file MPIComm.h.
Referenced by getRank().

string Sundance::MPIComm::machineName_ [static, private]

Definition at line 174 of file MPIComm.h.

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

MPIComm.h

Contact:

Kevin Long (krlong@ca.sandia.gov)

Documentation generated by