#include <Teuchos_DefaultMpiComm.hpp>
Public Member Functions | |
Constructors | |
MpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm) | |
Construct given a wrapped MPI_Comm oqaque object. | |
RCP< const OpaqueWrapper < MPI_Comm > > | getRawMpiComm () const |
Return the embedded wrapped opaque MPI_Comm object. | |
Overridden from Comm | |
virtual int | getRank () const |
| |
virtual int | getSize () const |
| |
virtual void | barrier () const |
| |
virtual void | broadcast (const int rootRank, const Ordinal bytes, char buffer[]) const |
| |
virtual void | gatherAll (const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvBytes, char recvBuffer[]) const |
| |
virtual void | reduceAll (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal bytes, const char sendBuffer[], char globalReducts[]) const |
| |
virtual void | reduceAllAndScatter (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvCounts[], char myGlobalReducts[]) const |
| |
virtual void | scan (const ValueTypeReductionOp< Ordinal, char > &reductOp, const Ordinal bytes, const char sendBuffer[], char scanReducts[]) const |
| |
virtual void | send (const Ordinal bytes, const char sendBuffer[], const int destRank) const |
| |
virtual int | receive (const int sourceRank, const Ordinal bytes, char recvBuffer[]) const |
| |
virtual void | readySend (const ArrayView< const char > &sendBuffer, const int destRank) const |
| |
virtual RCP< CommRequest > | isend (const ArrayView< const char > &sendBuffer, const int destRank) const |
| |
virtual RCP< CommRequest > | ireceive (const ArrayView< char > &Buffer, const int sourceRank) const |
| |
virtual void | waitAll (const ArrayView< RCP< CommRequest > > &requests) const |
| |
virtual void | wait (const Ptr< RCP< CommRequest > > &request) const |
| |
Overridden from Describable | |
std::string | description () const |
| |
Related Functions | |
(Note that these are not member functions.) | |
template<typename Ordinal > | |
RCP< MpiComm< Ordinal > > | createMpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm) |
Helper function that creates a dynamically allocated MpiComm object or returns Teuchos::null to correctly represent a null communicator. |
Assertions:
getRawMpiComm().get()!=NULL && *getRawMpiComm()!=MPI_COMM_NULL
getSize() > 0
0 <= getRank() && getRank() < getSize()
ToDo: Finish documentation!
Definition at line 121 of file Teuchos_DefaultMpiComm.hpp.
Teuchos::MpiComm< Ordinal >::MpiComm | ( | const RCP< const OpaqueWrapper< MPI_Comm > > & | rawMpiComm | ) | [inline] |
Construct given a wrapped MPI_Comm oqaque object.
Preconditions:
rawMpiComm.get()!=NULL && *rawMpiComm != MPI_COMM_NULL
Definition at line 278 of file Teuchos_DefaultMpiComm.hpp.
void Teuchos::MpiComm< Ordinal >::barrier | ( | ) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::broadcast | ( | const int | rootRank, | |
const Ordinal | bytes, | |||
char | buffer[] | |||
) | const [inline, virtual] |
std::string Teuchos::MpiComm< Ordinal >::description | ( | ) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::gatherAll | ( | const Ordinal | sendBytes, | |
const char | sendBuffer[], | |||
const Ordinal | recvBytes, | |||
char | recvBuffer[] | |||
) | const [inline, virtual] |
int Teuchos::MpiComm< Ordinal >::getRank | ( | ) | const [inline, virtual] |
RCP<const OpaqueWrapper<MPI_Comm> > Teuchos::MpiComm< Ordinal >::getRawMpiComm | ( | ) | const [inline] |
Return the embedded wrapped opaque MPI_Comm
object.
Definition at line 138 of file Teuchos_DefaultMpiComm.hpp.
int Teuchos::MpiComm< Ordinal >::getSize | ( | ) | const [inline, virtual] |
RCP< CommRequest > Teuchos::MpiComm< Ordinal >::ireceive | ( | const ArrayView< char > & | Buffer, | |
const int | sourceRank | |||
) | const [inline, virtual] |
RCP< CommRequest > Teuchos::MpiComm< Ordinal >::isend | ( | const ArrayView< const char > & | sendBuffer, | |
const int | destRank | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::readySend | ( | const ArrayView< const char > & | sendBuffer, | |
const int | destRank | |||
) | const [inline, virtual] |
int Teuchos::MpiComm< Ordinal >::receive | ( | const int | sourceRank, | |
const Ordinal | bytes, | |||
char | recvBuffer[] | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::reduceAll | ( | const ValueTypeReductionOp< Ordinal, char > & | reductOp, | |
const Ordinal | bytes, | |||
const char | sendBuffer[], | |||
char | globalReducts[] | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::reduceAllAndScatter | ( | const ValueTypeReductionOp< Ordinal, char > & | reductOp, | |
const Ordinal | sendBytes, | |||
const char | sendBuffer[], | |||
const Ordinal | recvCounts[], | |||
char | myGlobalReducts[] | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::scan | ( | const ValueTypeReductionOp< Ordinal, char > & | reductOp, | |
const Ordinal | bytes, | |||
const char | sendBuffer[], | |||
char | scanReducts[] | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::send | ( | const Ordinal | bytes, | |
const char | sendBuffer[], | |||
const int | destRank | |||
) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::wait | ( | const Ptr< RCP< CommRequest > > & | request | ) | const [inline, virtual] |
void Teuchos::MpiComm< Ordinal >::waitAll | ( | const ArrayView< RCP< CommRequest > > & | requests | ) | const [inline, virtual] |
RCP< MpiComm< Ordinal > > createMpiComm | ( | const RCP< const OpaqueWrapper< MPI_Comm > > & | rawMpiComm | ) | [related] |
Helper function that creates a dynamically allocated MpiComm
object or returns Teuchos::null
to correctly represent a null communicator.
Postconditions: [rawMpiComm.get()!=NULL && *rawMpiComm!=MPI_COMM_NULL
] return.get()!=NULL
[rawMpiComm.get()==NULL || *rawMpiComm==MPI_COMM_NULL
] return.get()==NULL