libMesh::Parallel::Status Class Reference

#include <status.h>

Public Member Functions
	Status ()
	Status (const data_type &type)
	Status (const status &status)
	Status (const status &status, const data_type &type)
	Status (const Status &status)
	Status (const Status &status, const data_type &type)
status *	get ()
status const *	get () const
int	source () const
int	tag () const
data_type &	datatype ()
const data_type &	datatype () const
unsigned int	size (const data_type &type) const
unsigned int	size () const

Private Attributes
status	_status
data_type	_datatype

Detailed Description

Encapsulates the MPI_Status struct. Allows the source and size of the message to be determined.

Definition at line 59 of file status.h.

Constructor & Destructor Documentation

Status() [1/6]

libMesh::Parallel::Status::Status ( )

inline

Definition at line 101 of file status.h.

                       :
  _status(),
  _datatype()
{}

Status() [2/6]

libMesh::Parallel::Status::Status ( const data_type &  type )

inlineexplicit

Definition at line 106 of file status.h.

                                             :
  _status(),
  _datatype(type)
{}

Status() [3/6]

libMesh::Parallel::Status::Status ( const status &  status )

inlineexplicit

Definition at line 111 of file status.h.

                                          :
  _status(stat),
  _datatype()
{}

Status() [4/6]

libMesh::Parallel::Status::Status ( const status &  status, const data_type &  type  )

inline

Definition at line 116 of file status.h.

                                               :
  _status(stat),
  _datatype(type)
{}

Status() [5/6]

libMesh::Parallel::Status::Status ( const Status &  status )

inline

Definition at line 122 of file status.h.

                                          :
  _status(stat._status),
  _datatype(stat._datatype)
{}

Status() [6/6]

libMesh::Parallel::Status::Status ( const Status &  status, const data_type &  type  )

inline

Definition at line 127 of file status.h.

                                               :
  _status(stat._status),
  _datatype(type)
{}

Member Function Documentation

datatype() [1/2]

data_type& libMesh::Parallel::Status::datatype ( )

inline

Definition at line 84 of file status.h.

References _datatype.

Referenced by size().

{ return _datatype; }

datatype() [2/2]

const data_type& libMesh::Parallel::Status::datatype ( ) const

inline

Definition at line 86 of file status.h.

References _datatype.

{ return _datatype; }

get() [1/2]

status* libMesh::Parallel::Status::get ( )

inline

Definition at line 76 of file status.h.

References _status.

Referenced by libMesh::Parallel::Communicator::packed_range_probe(), libMesh::Parallel::Communicator::receive(), and libMesh::Parallel::Request::wait().

{ return &_status; }

get() [2/2]

status const* libMesh::Parallel::Status::get ( ) const

inline

Definition at line 78 of file status.h.

References _status.

{ return &_status; }

size() [1/2]

unsigned int libMesh::Parallel::Status::size ( const data_type &  type ) const

inline

Definition at line 152 of file status.h.

References _status, and libMesh::libmesh_ignore().

Referenced by libMesh::Parallel::Communicator::nonblocking_receive_packed_range(), and libMesh::SparsityPattern::Build::parallel_sync().

{
  libmesh_ignore(type); // We don't use this ifndef LIBMESH_HAVE_MPI
  int msg_size = 1;
  libmesh_call_mpi
    (MPI_Get_count (const_cast<MPI_Status*>(&_status), type,
                    &msg_size));

  libmesh_assert_greater_equal (msg_size, 0);
  return msg_size;
}

size() [2/2]

unsigned int libMesh::Parallel::Status::size ( ) const

inline

Definition at line 164 of file status.h.

References datatype().

{ return this->size (this->datatype()); }

source()

int libMesh::Parallel::Status::source ( ) const

inline

Definition at line 133 of file status.h.

References _status.

Referenced by libMesh::System::read_serialized_blocked_dof_objects(), libMesh::Parallel::Communicator::receive_packed_range(), and libMesh::System::write_serialized_blocked_dof_objects().

{
#ifdef LIBMESH_HAVE_MPI
  return _status.MPI_SOURCE;
#else
  return 0;
#endif
}

tag()

int libMesh::Parallel::Status::tag ( ) const

inline

Definition at line 142 of file status.h.

References _status.

Referenced by libMesh::Parallel::Communicator::receive_packed_range().

{
#ifdef LIBMESH_HAVE_MPI
  return _status.MPI_TAG;
#else
  libmesh_not_implemented();
  return 0;
#endif
}

Member Data Documentation

_datatype

data_type libMesh::Parallel::Status::_datatype

private

Definition at line 95 of file status.h.

Referenced by datatype().

_status

status libMesh::Parallel::Status::_status

private

Definition at line 94 of file status.h.

Referenced by get(), size(), source(), and tag().

---

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

• status.h