Teuchos - Trilinos Tools Package Version of the Day
Public Member Functions
Teuchos::MpiCommRequest< OrdinalType > Class Template Reference

MPI implementation of CommRequest. More...

#include <Teuchos_DefaultMpiComm.hpp>

Inheritance diagram for Teuchos::MpiCommRequest< OrdinalType >:
Teuchos::MpiCommRequestBase< OrdinalType > Teuchos::CommRequest< OrdinalType > Teuchos::Describable Teuchos::LabeledObject

List of all members.

Public Member Functions

 MpiCommRequest ()
 Default constructor.
 MpiCommRequest (MPI_Request rawMpiRequest, const ArrayView< char >::size_type numBytesInMessage)
 Constructor (from a raw MPI_Request).
ArrayView< char >::size_type numBytes () const
 Number of bytes in the nonblocking send or receive request.
virtual ~MpiCommRequest ()
 Destructor; cancels the request if it is still pending.

Detailed Description

template<class OrdinalType>
class Teuchos::MpiCommRequest< OrdinalType >

MPI implementation of CommRequest.

Template Parameters:
OrdinalTypeSame as the template parameter of Comm.

This class wraps MPI_Request, which is MPI's reification of a nonblocking communication operation.

Users would not normally create an instance of this class. Calls to nonblocking communication operations (such as ireceive() or isend()) return a pointer to a CommRequest. If the Comm is an MpiComm, then the returned CommRequest is an MpiCommRequest.

Users might wish to create an MpiCommRequest directly if they want to encapsulate an MPI_Request returned by an external library or by their own code.

Definition at line 309 of file Teuchos_DefaultMpiComm.hpp.

Constructor & Destructor Documentation

template<class OrdinalType >
Teuchos::MpiCommRequest< OrdinalType >::MpiCommRequest ( ) [inline]

Default constructor.

Definition at line 312 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >
Teuchos::MpiCommRequest< OrdinalType >::MpiCommRequest ( MPI_Request  rawMpiRequest,
const ArrayView< char >::size_type  numBytesInMessage 
) [inline]

Constructor (from a raw MPI_Request).

Definition at line 318 of file Teuchos_DefaultMpiComm.hpp.

template<class OrdinalType >
virtual Teuchos::MpiCommRequest< OrdinalType >::~MpiCommRequest ( ) [inline, virtual]

Destructor; cancels the request if it is still pending.

Definition at line 334 of file Teuchos_DefaultMpiComm.hpp.

Member Function Documentation

template<class OrdinalType >
ArrayView<char>::size_type Teuchos::MpiCommRequest< OrdinalType >::numBytes ( ) const [inline]

Number of bytes in the nonblocking send or receive request.

Remembering this is inexpensive, and is also useful for debugging (e.g., for detecting whether the send and receive have matching message lengths).

Definition at line 329 of file Teuchos_DefaultMpiComm.hpp.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines