Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Related Symbols | List of all members
Teuchos::MpiComm< Ordinal > Class Template Reference

Implementation of Comm that uses MPI for communication. More...

#include <Teuchos_DefaultMpiComm_decl.hpp>

Inheritance diagram for Teuchos::MpiComm< Ordinal >:
Teuchos::Comm< Ordinal > Teuchos::Describable Teuchos::LabeledObject

Public Member Functions

Constructors
 MpiComm (MPI_Comm rawMpiComm)
 Construct an MpiComm with an MPI_Comm.
 
 MpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm)
 Construct an MpiComm with the given wrapped MPI_Comm.
 
 MpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm, const int defaultTag)
 Construct an MpiComm with a wrapped MPI_Comm and a default tag.
 
 MpiComm (const MpiComm< Ordinal > &other)
 Construct a communicator with a new context with the same properties as the original.
 
RCP< const OpaqueWrapper< MPI_Comm > > getRawMpiComm () const
 Return the embedded wrapped opaque MPI_Comm object.
 
void setErrorHandler (const RCP< const OpaqueWrapper< MPI_Errhandler > > &errHandler)
 Set the MPI error handler for this communicator.
 
Implementation of Comm interface
virtual int getRank () const
 The calling process' rank.
 
virtual int getSize () const
 The number of processes in the communicator.
 
virtual void barrier () const
 Execute a barrier; must be called collectively.
 
virtual void broadcast (const int rootRank, const Ordinal bytes, char buffer[]) const
 
virtual void gather (const Ordinal sendBytes, const char sendBuffer[], const Ordinal recvBytes, char recvBuffer[], const int root) const
 Gather values from all processes to the root process.
 
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 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 void send (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 
virtual void ssend (const Ordinal bytes, const char sendBuffer[], const int destRank) const
 
virtual void ssend (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 Variant of ssend() that takes a message tag.
 
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 void readySend (const Ordinal bytes, const char sendBuffer[], const int destRank, const int tag) const
 Variant of readySend() that accepts a message tag.
 
virtual RCP< CommRequest< Ordinal > > isend (const ArrayView< const char > &sendBuffer, const int destRank) const
 
virtual RCP< CommRequest< Ordinal > > isend (const ArrayView< const char > &sendBuffer, const int destRank, const int tag) const
 Variant of isend() that takes a tag.
 
virtual RCP< CommRequest< Ordinal > > ireceive (const ArrayView< char > &Buffer, const int sourceRank) const
 
virtual RCP< CommRequest< Ordinal > > ireceive (const ArrayView< char > &Buffer, const int sourceRank, const int tag) const
 
virtual void waitAll (const ArrayView< RCP< CommRequest< Ordinal > > > &requests) const
 
virtual void waitAll (const ArrayView< RCP< CommRequest< Ordinal > > > &requests, const ArrayView< RCP< CommStatus< Ordinal > > > &statuses) const
 
virtual RCP< CommStatus< Ordinal > > wait (const Ptr< RCP< CommRequest< Ordinal > > > &request) const
 
virtual RCP< Comm< Ordinal > > duplicate () const
 
virtual RCP< Comm< Ordinal > > split (const int color, const int key) const
 
virtual RCP< Comm< Ordinal > > createSubcommunicator (const ArrayView< const int > &ranks) const
 
- Public Member Functions inherited from Teuchos::Comm< Ordinal >
virtual ~Comm ()
 Destructor, declared virtual for safety of derived classes.
 
- Public Member Functions inherited from Teuchos::Describable
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream.
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream.
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes).
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label.
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject).
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject).
 

Related Symbols

(Note that these are not member symbols.)

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.
 
template<typename Ordinal >
RCP< MpiComm< Ordinal > > createMpiComm (const RCP< const OpaqueWrapper< MPI_Comm > > &rawMpiComm, const int defaultTag)
 Helper function that creates a dynamically allocated MpiComm object or returns Teuchos::null to correctly represent a null communicator.
 
template<typename Ordinal >
MPI_Comm getRawMpiComm (const Comm< Ordinal > &comm)
 Helper function that extracts a raw MPI_Comm object out of a Teuchos::MpiComm wrapper object.
 
- Related Symbols inherited from Teuchos::Comm< Ordinal >
 Predefined reduction operations that Teuchos::Comm understands. More...
 
int rank (const Comm< Ordinal > &comm)
 Get the process rank.
 
int size (const Comm< Ordinal > &comm)
 Get the number of processes in the communicator.
 
void barrier (const Comm< Ordinal > &comm)
 Barrier.
 
void broadcast (const Comm< Ordinal > &comm, const int rootRank, const Ordinal count, Packet buffer[])
 Broadcast array of objects that use value semantics.
 
void broadcast (const Comm< Ordinal > &comm, const int rootRank, const ArrayView< Packet > &buffer)
 Broadcast array of objects that use value semantics.
 
void broadcast (const Comm< Ordinal > &comm, const int rootRank, Packet *object)
 Broadcast single object that use value semantics.
 
void broadcast (const Comm< Ordinal > &comm, const int rootRank, const Ptr< Packet > &object)
 Broadcast single object that use value semantics.
 
void broadcast (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const int rootRank, const Ordinal count, Packet *const buffer[])
 Broadcast array of objects that use reference semantics.
 
void broadcast (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const int rootRank, const ArrayView< const Ptr< Packet > > &buffer)
 Broadcast array of objects that use reference semantics.
 
void broadcast (const Comm< Ordinal > &comm, const Serializer &serializer, const int rootRank, const Ordinal count, Packet buffer[])
 Broadcast array of objects that use value semantics using customized serializer.
 
void gather (const Packet sendBuf[], const Ordinal sendCount, Packet recvBuf[], const Ordinal recvCount, const int root, const Comm< Ordinal > &comm)
 Gather values from each process to the root process.
 
void gatherv (const Packet sendBuf[], const Ordinal sendCount, Packet recvBuf[], const Ordinal recvCounts[], const Ordinal displs[], const int root, const Comm< Ordinal > &comm)
 Gather arrays of possibly different lengths from each process to the root process.
 
void gatherAll (const Comm< Ordinal > &comm, const Ordinal sendCount, const Packet sendBuffer[], const Ordinal recvCount, Packet recvBuffer[])
 Gather array of objects that use value semantics from every process to every process.
 
void gatherAll (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const Ordinal sendCount, const Packet *const sendBuffer[], const Ordinal recvCount, Packet *const recvBuffer[])
 Gather array of objects that use reference semantics from every process to every process.
 
void gatherAll (const Comm< Ordinal > &comm, const Serializer &serializer, const Ordinal sendCount, const Packet sendBuffer[], const Ordinal recvCount, Packet recvBuffer[])
 Gather array of objects that use value semantics from every process to every process using customized serializer.
 
void scatter (const Packet sendBuf[], const Ordinal sendCount, Packet recvBuf[], const Ordinal recvCount, const Ordinal root, const Comm< Ordinal > &comm)
 Wrapper for MPI_Scatter; scatter collective.
 
void reduce (const Packet sendBuf[], Packet recvBuf[], const Ordinal count, const EReductionType reductType, const Ordinal root, const Comm< Ordinal > &comm)
 Wrapper for MPI_Reduce; reduction to one process, using a built-in reduction operator selected by enum.
 
void reduceAll (const Comm< Ordinal > &comm, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
 Wrapper for MPI_Allreduce that takes a custom reduction operator.
 
void reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
 Collective reduce all of array of objects using value semantics using a pre-defined reduction type.
 
void reduceAll (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, const Ptr< Packet > &globalReduct)
 Collective reduce all for single object using value semantics using a pre-defined reduction type.
 
void reduceAll (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const ReferenceTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet *const sendBuffer[], Packet *const globalReducts[])
 Collective reduce all for array of objects using reference semantics.
 
void reduceAll (const Comm< Ordinal > &comm, const Serializer &serializer, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
 Collective reduce all of array of objects using value semantics using a user-defined reduction operator and customized serializer.
 
void reduceAll (const Comm< Ordinal > &comm, const Serializer &serializer, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet globalReducts[])
 Collective reduce all of array of objects using value semantics using a pre-defined reduction type and customized serializer.
 
void scan (const Comm< Ordinal > &comm, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
 Scan/Reduce array of objects that use value semantics using a user-defined reduction operator.
 
void scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
 Scan/Reduce array of objects using value semantics using a predefined reduction type.
 
void scan (const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, const Ptr< Packet > &scanReduct)
 Scan/Reduce single object using value semantics using a predefined reduction type.
 
void scan (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const ReferenceTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet *const sendBuffer[], Packet *const scanReducts[])
 Scan/Reduce array of objects that use reference semantics using a user-defined reduction operator.
 
void scan (const Comm< Ordinal > &comm, const Serializer &serializer, const ValueTypeReductionOp< Ordinal, Packet > &reductOp, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
 Scan/Reduce array of objects that use value semantics using a user-defined reduction operator and customized serializer.
 
void scan (const Comm< Ordinal > &comm, const Serializer &serializer, const EReductionType reductType, const Ordinal count, const Packet sendBuffer[], Packet scanReducts[])
 Scan/Reduce array of objects using value semantics using a predefined reduction type and customized serializer.
 
void send (const Comm< Ordinal > &comm, const Ordinal count, const Packet sendBuffer[], const int destRank)
 Send objects that use values semantics to another process.
 
void ssend (const Comm< Ordinal > &comm, const Ordinal count, const Packet sendBuffer[], const int destRank)
 Synchronously send objects that use values semantics to another process.
 
void send (const Comm< Ordinal > &comm, const Packet &send, const int destRank)
 Send a single object that use values semantics to another process.
 
void ssend (const Comm< Ordinal > &comm, const Packet &send, const int destRank)
 Synchronously send a single object that use values semantics to another process.
 
void send (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const Ordinal count, const Packet *const sendBuffer[], const int destRank)
 Send objects that use reference semantics to another process.
 
void send (const Comm< Ordinal > &comm, const Serializer &serializer, const Ordinal count, const Packet sendBuffer[], const int destRank)
 Send objects that use values semantics to another process using customized serializer.
 
int receive (const Comm< Ordinal > &comm, const int sourceRank, const Ordinal count, Packet recvBuffer[])
 Receive objects that use values semantics from another process.
 
int receive (const Comm< Ordinal > &comm, const int sourceRank, Packet *recv)
 Receive a single object that use values semantics from another process.
 
int receive (const Comm< Ordinal > &comm, const Serializer< Ordinal, Packet > &serializer, const int sourceRank, const Ordinal count, Packet *const recvBuffer[])
 Receive objects that use reference semantics from another process.
 
int receive (const Comm< Ordinal > &comm, const Serializer &serializer, const int sourceRank, const Ordinal count, Packet recvBuffer[])
 Receive objects that use values semantics from another process using customized serializer.
 
void readySend (const Comm< Ordinal > &comm, const ArrayView< const Packet > &sendBuffer, const int destRank)
 Ready-Send an array of objects that use values semantics to another process.
 
void readySend (const Comm< Ordinal > &comm, const Packet &send, const int destRank)
 Ready-Send a single object that use values semantics to another process.
 
void readySend (const Comm< Ordinal > &comm, const Serializer &serializer, const ArrayView< const Packet > &sendBuffer, const int destRank)
 Ready-Send an array of objects that use values semantics to another process using customized serializer.
 
RCP< CommRequest< Ordinal > > isend (const Comm< Ordinal > &comm, const ArrayRCP< const Packet > &sendBuffer, const int destRank)
 Send objects that use values semantics to another process.
 
RCP< CommRequest< Ordinal > > isend (const Comm< Ordinal > &comm, const RCP< const Packet > &send, const int destRank)
 Send a single object that use values semantics to another process.
 
RCP< CommRequest< Ordinal > > isend (const Comm< Ordinal > &comm, const Serializer &serializer, const ArrayRCP< const Packet > &sendBuffer, const int destRank)
 Send objects that use values semantics to another process using customized serializer.
 
RCP< CommRequest< Ordinal > > ireceive (const Comm< Ordinal > &comm, const ArrayRCP< Packet > &recvBuffer, const int sourceRank)
 Receive one or more objects (that use values semantics) from another process.
 
RCP< CommRequest< Ordinal > > ireceive (const Comm< Ordinal > &comm, const RCP< Packet > &recv, const int sourceRank)
 Receive one object (that uses values semantics) from another process.
 
RCP< CommRequest< Ordinal > > ireceive (const Comm< Ordinal > &comm, const Serializer &serializer, const ArrayRCP< Packet > &recvBuffer, const int sourceRank)
 Send objects that use values semantics to another process using customized serializer.
 
void waitAll (const Comm< Ordinal > &comm, const ArrayView< RCP< CommRequest< Ordinal > > > &requests)
 Wait for an array of Teuchos::CommRequest objects.
 
void waitAll (const Comm< Ordinal > &comm, const ArrayView< RCP< CommRequest< Ordinal > > > &requests, const ArrayView< RCP< CommStatus< Ordinal > > > &statuses)
 Wait on one or more communication requests, and return their statuses.
 
RCP< CommStatus< Ordinal > > wait (const Comm< Ordinal > &comm, const Ptr< RCP< CommRequest< Ordinal > > > &request)
 Wait on a single communication request, and return its status.
 
- Related Symbols inherited from Teuchos::Describable
 Describable output stream manipulator.
 
 Output stream operator for Describable manipulator.
 

Implementation of Describable interface

std::string description () const
 
int getTag () const
 The current tag.
 
int incrementTag ()
 Increments the tag and then returns it.
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe().
 

Detailed Description

template<typename Ordinal>
class Teuchos::MpiComm< Ordinal >

Implementation of Comm that uses MPI for communication.

Template Parameters
OrdinalThe index type for communication; same as the template parameter of Comm.

This class uses MPI (the Message Passing Interface) to implement the Comm interface. It includes constructors that take an MPI_Comm from the application.

Assertions:

Definition at line 189 of file Teuchos_DefaultMpiComm_decl.hpp.

Constructor & Destructor Documentation

◆ MpiComm() [1/4]

template<typename Ordinal >
Teuchos::MpiComm< Ordinal >::MpiComm ( MPI_Comm  rawMpiComm)
explicit

Construct an MpiComm with an MPI_Comm.

This constructs an MpiComm that uses the given "raw" MPI communicator underneath. The MPI_Comm must be valid for the lifetime of this MpiComm. You are responsible for freeing the MPI_Comm (using MPI_Comm_free) if necessary.

This constructor should be used only in one of two cases:

  1. When the given MPI_Comm is one of the predefined communicators that need not and must not be freed after use, like MPI_COMM_WORLD or MPI_COMM_SELF.
  2. When you know that the given MPI_Comm will not be freed until after the lifetime of this MpiComm.

If you cannot be sure of either of these two conditions, you should use the version of the constructor that takes an RCP<const OpaqueWrapper<MPI_Comm> >.

Precondition:

  • rawMpiComm != MPI_COMM_NULL

◆ MpiComm() [2/4]

template<typename Ordinal >
Teuchos::MpiComm< Ordinal >::MpiComm ( const RCP< const OpaqueWrapper< MPI_Comm > > &  rawMpiComm)

Construct an MpiComm with the given wrapped MPI_Comm.

This constructs an MpiComm that uses the given "raw" MPI communicator underneath. This version of the constructor accepts the MPI_Comm wrapped in an OpaqueWrapper, which along with the RCP has the option to free the MPI_Comm (via MPI_Comm_free) after use if necessary. You are responsible when creating the OpaqueWrapper for supplying a "free" function if needed. We recommend using details::safeCommFree for the "free" function, if one is needed.

Preconditions:

  • rawMpiComm.get() != NULL
  • *rawMpiComm != MPI_COMM_NULL

◆ MpiComm() [3/4]

template<typename Ordinal >
Teuchos::MpiComm< Ordinal >::MpiComm ( const RCP< const OpaqueWrapper< MPI_Comm > > &  rawMpiComm,
const int  defaultTag 
)

Construct an MpiComm with a wrapped MPI_Comm and a default tag.

This constructor has the same meaning as the one-argument constructor that takes RCP<const OpaqueWrapper<MPI_Comm> >, except that it sets the default message tag on all processes to defaultTag. This avoids the MPI_Bcast that the other two constructors do.

This constructor is declared private for now, because it is an implementation detail of duplicate(). We may choose to expose it in the future.

Preconditions:

  • rawMpiComm.get() != NULL
  • *rawMpiComm != MPI_COMM_NULL
  • defaultTag is the same on all processes in the given communicator

◆ MpiComm() [4/4]

template<typename Ordinal >
Teuchos::MpiComm< Ordinal >::MpiComm ( const MpiComm< Ordinal > &  other)

Construct a communicator with a new context with the same properties as the original.

The newly constructed communicator will have a duplicate communication space that has the same properties (e.g. processes, attributes, topologies) as the input communicator.

Parameters
otherThe communicator to copy from.

Preconditions:

Member Function Documentation

◆ getRawMpiComm()

template<typename Ordinal >
RCP< const OpaqueWrapper< MPI_Comm > > Teuchos::MpiComm< Ordinal >::getRawMpiComm ( ) const
inline

Return the embedded wrapped opaque MPI_Comm object.

Definition at line 271 of file Teuchos_DefaultMpiComm_decl.hpp.

◆ setErrorHandler()

template<typename Ordinal >
void Teuchos::MpiComm< Ordinal >::setErrorHandler ( const RCP< const OpaqueWrapper< MPI_Errhandler > > &  errHandler)

Set the MPI error handler for this communicator.

Parameters
errHandler[in] The error handler to set. If null, do nothing.

MPI lets you set an error handler function specific to each communicator. (See Section 8.3 of the MPI 3.0 Standard.) MpiComm wraps this functionality using this method. You must first either create an error handler using MPI_Comm_create_errhandler() (or MPI_Errhandler_create() if you are stuck with an MPI 1 implementation), or use one of the default error handlers that the MPI standard or your MPI implementation provides. You will need to wrap the MPI error handler in an OpaqueWrapper. (See the documentation of OpaqueWrapper for the rationale behind not using MPI's opaque objects directly.)

MpiComm will not attempt to call MPI_Errhandler_free() on the error handler you provide. You are responsible for arranging that this be done. Note that MPI_Comm_create_errhandler() (which creates an error handler, given a function pointer) does not attach the error handler to an MPI_Comm, so the lifetime of the error handler is not tied to the MPI_Comm to which it is assigned. An error handler can be assigned to more than one MPI_Comm, in fact. You just need to guarantee that if you create a custom error handler, then that handler gets freed at some point. "The call to <tt>MPI_FINALIZE</tt> does not free objects created by MPI calls; these objects are freed using <tt>MPI_xxx_FREE</tt> calls" (Section 8.7, MPI 3.0 Standard). Note that it is legitimate to call MPI_Errhandler_free() right after setting the MPI_Comm's error handler; see Section 8.3.4 of the MPI 3.0 Standard ("The error handler [given to MPI_Errhandler_free] will be deallocated after all the objects associated with it (communicator, window, or file) have been deallocated"). You might instead attach your error handler as a attribute to MPI_COMM_SELF, in such a way that MPI_Errhandler_free() will be called when MPI_COMM_SELF is freed (which MPI_Finalize() does automatically). We do not take responsibility for doing any of these things; you are responsible for freeing the error handler.

Here is an example showing how to change an MpiComm's error handler. The default error handler for any MPI_Comm is MPI_ERRORS_ARE_FATAL. This handler immediately aborts if MPI encounters an error, without returning an error code from the MPI function. Suppose that instead you would like MPI functions to return an error code if MPI should encounter an error. (In that case, Teuchos' MPI wrappers will detect the returned error code and throw an exception with an appropriate error message. If MPI aborts immediately on error, Teuchos won't have the chance to detect and report the error.) If so, you may set the error handler to MPI_ERRORS_RETURN, one of MPI's built-in error handlers. Here is how you may do this for an MpiComm:

// Suppose that you've already created this MpiComm.
RCP<const MpiComm<int> > comm = ...;
// Wrap the error handler.
RCP<const OpaqueWrapper<MPI_Errhandler> > errHandler =
rcp (new OpaqueWrapper<MPI_Errhandler> (MPI_ERRORS_RETURN));
// Set the MpiComm's error handler.
comm->setErrorHandler (errHandler);
Teuchos::RCP
Smart reference counting pointer class for automatic garbage collection.
Definition Teuchos_RCPDecl.hpp:397
Teuchos::rcp
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Deprecated.
Definition Teuchos_RCPDecl.hpp:1234

◆ getRank()

template<typename Ordinal >
virtual int Teuchos::MpiComm< Ordinal >::getRank ( ) const
virtual

The calling process' rank.

Implements Teuchos::Comm< Ordinal >.

◆ getSize()

template<typename Ordinal >
virtual int Teuchos::MpiComm< Ordinal >::getSize ( ) const
virtual

The number of processes in the communicator.

Implements Teuchos::Comm< Ordinal >.

◆ barrier()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::barrier ( ) const
virtual

Execute a barrier; must be called collectively.

Implements Teuchos::Comm< Ordinal >.

◆ broadcast()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::broadcast ( const int  rootRank,
const Ordinal  bytes,
char  buffer[] 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ gather()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::gather ( const Ordinal  sendBytes,
const char  sendBuffer[],
const Ordinal  recvBytes,
char  recvBuffer[],
const int  root 
) const
virtual

Gather values from all processes to the root process.

Implements Teuchos::Comm< Ordinal >.

◆ gatherAll()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::gatherAll ( const Ordinal  sendBytes,
const char  sendBuffer[],
const Ordinal  recvBytes,
char  recvBuffer[] 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ reduceAll()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::reduceAll ( const ValueTypeReductionOp< Ordinal, char > &  reductOp,
const Ordinal  bytes,
const char  sendBuffer[],
char  globalReducts[] 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ scan()

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::scan ( const ValueTypeReductionOp< Ordinal, char > &  reductOp,
const Ordinal  bytes,
const char  sendBuffer[],
char  scanReducts[] 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ send() [1/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::send ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ send() [2/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::send ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ ssend() [1/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::ssend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ ssend() [2/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::ssend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const
virtual

Variant of ssend() that takes a message tag.

Implements Teuchos::Comm< Ordinal >.

◆ receive()

template<typename Ordinal >
virtual int Teuchos::MpiComm< Ordinal >::receive ( const int  sourceRank,
const Ordinal  bytes,
char  recvBuffer[] 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ readySend() [1/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::readySend ( const ArrayView< const char > &  sendBuffer,
const int  destRank 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ readySend() [2/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::readySend ( const Ordinal  bytes,
const char  sendBuffer[],
const int  destRank,
const int  tag 
) const
virtual

Variant of readySend() that accepts a message tag.

Implements Teuchos::Comm< Ordinal >.

◆ isend() [1/2]

template<typename Ordinal >
virtual RCP< CommRequest< Ordinal > > Teuchos::MpiComm< Ordinal >::isend ( const ArrayView< const char > &  sendBuffer,
const int  destRank 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ isend() [2/2]

template<typename Ordinal >
virtual RCP< CommRequest< Ordinal > > Teuchos::MpiComm< Ordinal >::isend ( const ArrayView< const char > &  sendBuffer,
const int  destRank,
const int  tag 
) const
virtual

Variant of isend() that takes a tag.

Implements Teuchos::Comm< Ordinal >.

◆ ireceive() [1/2]

template<typename Ordinal >
virtual RCP< CommRequest< Ordinal > > Teuchos::MpiComm< Ordinal >::ireceive ( const ArrayView< char > &  Buffer,
const int  sourceRank 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ ireceive() [2/2]

template<typename Ordinal >
virtual RCP< CommRequest< Ordinal > > Teuchos::MpiComm< Ordinal >::ireceive ( const ArrayView< char > &  Buffer,
const int  sourceRank,
const int  tag 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ waitAll() [1/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::waitAll ( const ArrayView< RCP< CommRequest< Ordinal > > > &  requests) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ waitAll() [2/2]

template<typename Ordinal >
virtual void Teuchos::MpiComm< Ordinal >::waitAll ( const ArrayView< RCP< CommRequest< Ordinal > > > &  requests,
const ArrayView< RCP< CommStatus< Ordinal > > > &  statuses 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ wait()

template<typename Ordinal >
virtual RCP< CommStatus< Ordinal > > Teuchos::MpiComm< Ordinal >::wait ( const Ptr< RCP< CommRequest< Ordinal > > > &  request) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ duplicate()

template<typename Ordinal >
virtual RCP< Comm< Ordinal > > Teuchos::MpiComm< Ordinal >::duplicate ( ) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ split()

template<typename Ordinal >
virtual RCP< Comm< Ordinal > > Teuchos::MpiComm< Ordinal >::split ( const int  color,
const int  key 
) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ createSubcommunicator()

template<typename Ordinal >
virtual RCP< Comm< Ordinal > > Teuchos::MpiComm< Ordinal >::createSubcommunicator ( const ArrayView< const int > &  ranks) const
virtual

Implements Teuchos::Comm< Ordinal >.

◆ description()

template<typename Ordinal >
std::string Teuchos::MpiComm< Ordinal >::description ( ) const
virtual

Reimplemented from Teuchos::Describable.

◆ getTag()

template<typename Ordinal >
int Teuchos::MpiComm< Ordinal >::getTag ( ) const
inlinevirtual

The current tag.

Warning
This method is ONLY for use by Teuchos developers. Users should not depend on the interface of this method. It may change or disappear at any time without warning.

Implements Teuchos::Comm< Ordinal >.

Definition at line 472 of file Teuchos_DefaultMpiComm_decl.hpp.

◆ incrementTag()

template<typename Ordinal >
int Teuchos::MpiComm< Ordinal >::incrementTag ( )
inlinevirtual

Increments the tag and then returns it.

Implements Teuchos::Comm< Ordinal >.

Definition at line 474 of file Teuchos_DefaultMpiComm_decl.hpp.

Friends And Related Symbol Documentation

◆ createMpiComm() [1/2]

template<typename Ordinal >
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

◆ createMpiComm() [2/2]

template<typename Ordinal >
RCP< MpiComm< Ordinal > > createMpiComm ( const RCP< const OpaqueWrapper< MPI_Comm > > &  rawMpiComm,
const int  defaultTag 
)
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

◆ getRawMpiComm()

template<typename Ordinal >
MPI_Comm getRawMpiComm ( const Comm< Ordinal > &  comm)
related

Helper function that extracts a raw MPI_Comm object out of a Teuchos::MpiComm wrapper object.

Preconditions: dynamic_cast<const MpiComm<Ordinal>*>(&comm) != 0

If the underlying type is not an MpiComm<Ordinal> object, then the function with throw an exception which contains the type information as for why it failed.

WARNING: The lifetime of the returned MPI_Comm object is controlled by the owning RCP<OpaqueWrapper<MPI_Comm> > object and is not guaranteed to live the entire life of the program. Therefore, only use this function to grab and use the underlying MPI_Comm object in a vary narrow scope and then forget it. If you need it again, get it off of the comm object each time.

If you want a memory safe RCP<OpaqueWrapper<MPI_Comm> > to the raw MPI_Comm object, then call:

* dyn_cast<const MpiComm<Ordinal> >(comm).getRawMpiComm()
*

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8