Teuchos - Trilinos Tools Package Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Teuchos::MpiCommStatus< OrdinalType > Class Template Reference

MPI-specific implementation of CommStatus. More...

#include <Teuchos_DefaultMpiComm_decl.hpp>

Inheritance diagram for Teuchos::MpiCommStatus< OrdinalType >:
Teuchos::CommStatus< OrdinalType >

Public Member Functions

virtual ~MpiCommStatus ()
 Destructor (declared virtual for memory safety)
 
OrdinalType getSourceRank ()
 The source rank that sent the message.
 
OrdinalType getTag ()
 The tag of the received message.
 
OrdinalType getError ()
 The error code of the received message.
 
- Public Member Functions inherited from Teuchos::CommStatus< OrdinalType >
virtual ~CommStatus ()
 Destructor (declared virtual for memory safety)
 

Detailed Description

template<class OrdinalType>
class Teuchos::MpiCommStatus< OrdinalType >

MPI-specific implementation of CommStatus.

Users would not normally create an instance of this class. The only time they might wish to do so is to encapsulate an MPI_Status returned by an external library or by their own code, and pass it into one of our functions like wait() or waitAll().

Template Parameters
OrdinalTypeThe same template parameter as Comm. Only use int here. We only make this a template class for compatibility with Comm.

Definition at line 29 of file Teuchos_DefaultMpiComm_decl.hpp.

Constructor & Destructor Documentation

◆ ~MpiCommStatus()

Destructor (declared virtual for memory safety)

Member Function Documentation

◆ getSourceRank()

template<class OrdinalType >
OrdinalType Teuchos::MpiCommStatus< OrdinalType >::getSourceRank ( )
virtual

The source rank that sent the message.

Implements Teuchos::CommStatus< OrdinalType >.

◆ getTag()

template<class OrdinalType >
OrdinalType Teuchos::MpiCommStatus< OrdinalType >::getTag ( )
virtual

The tag of the received message.

Implements Teuchos::CommStatus< OrdinalType >.

◆ getError()

The error code of the received message.


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