Block-Structured AMR Software Framework
amrex::ParallelDescriptor::Message Class Reference

Hold the description and status of communication data. More...

#include <AMReX_ParallelDescriptor.H>

Public Member Functions

 Message ()=default
 
 Message (MPI_Request req_, MPI_Datatype type_)
 
 Message (MPI_Status stat_, MPI_Datatype type_)
 
void wait ()
 
bool test ()
 
size_t count () const
 
int tag () const
 
int pid () const
 
MPI_Datatype type () const
 
MPI_Request req () const
 
MPI_Status stat () const
 

Private Attributes

bool m_finished = true
 
MPI_Datatype m_type = MPI_DATATYPE_NULL
 
MPI_Request m_req = MPI_REQUEST_NULL
 
MPI_Status m_stat {}
 

Detailed Description

Hold the description and status of communication data.

Constructor & Destructor Documentation

◆ Message() [1/3]

amrex::ParallelDescriptor::Message::Message ( )
default

◆ Message() [2/3]

amrex::ParallelDescriptor::Message::Message ( MPI_Request  req_,
MPI_Datatype  type_ 
)
inline

◆ Message() [3/3]

amrex::ParallelDescriptor::Message::Message ( MPI_Status  stat_,
MPI_Datatype  type_ 
)
inline

Member Function Documentation

◆ count()

size_t amrex::ParallelDescriptor::Message::count ( ) const

◆ pid()

int amrex::ParallelDescriptor::Message::pid ( ) const

◆ req()

MPI_Request amrex::ParallelDescriptor::Message::req ( ) const
inline

◆ stat()

MPI_Status amrex::ParallelDescriptor::Message::stat ( ) const
inline

◆ tag()

int amrex::ParallelDescriptor::Message::tag ( ) const

◆ test()

bool amrex::ParallelDescriptor::Message::test ( )

◆ type()

MPI_Datatype amrex::ParallelDescriptor::Message::type ( ) const
inline

◆ wait()

void amrex::ParallelDescriptor::Message::wait ( )

Member Data Documentation

◆ m_finished

bool amrex::ParallelDescriptor::Message::m_finished = true
private

◆ m_req

MPI_Request amrex::ParallelDescriptor::Message::m_req = MPI_REQUEST_NULL
private

◆ m_stat

MPI_Status amrex::ParallelDescriptor::Message::m_stat {}
mutableprivate

◆ m_type

MPI_Datatype amrex::ParallelDescriptor::Message::m_type = MPI_DATATYPE_NULL
private

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