olb::singleton::MpiNonBlockingHelper Class Reference

Helper class for non blocking MPI communication. More...

#include <mpiManager.h>

Collaboration diagram for olb::singleton::MpiNonBlockingHelper:

Public Member Functions
	MpiNonBlockingHelper ()
	~MpiNonBlockingHelper ()=default
	MpiNonBlockingHelper (MpiNonBlockingHelper &&rhs)=default
	MpiNonBlockingHelper (const MpiNonBlockingHelper &)=delete
MpiNonBlockingHelper &	operator= (const MpiNonBlockingHelper &)=delete
void	allocate (unsigned i)
	Allocates memory.
void	free ()
	Reset.
unsigned	get_size () const
	Returns the size of the vector _mpiRequest/_mpiStatus.
MPI_Request *	get_mpiRequest (int i=0) const
	Get the specified request object.
MPI_Status *	get_mpiStatus (int i=0) const
	Get the specified status object.
void	start (int i)
void	wait (int i)
bool	isDone (int i)
void	swap (MpiNonBlockingHelper &rhs)
	Swap method.

Detailed Description

Helper class for non blocking MPI communication.

Definition at line 51 of file mpiManager.h.

Constructor & Destructor Documentation

MpiNonBlockingHelper() [1/3]

olb::singleton::MpiNonBlockingHelper::MpiNonBlockingHelper

(

)

Definition at line 1312 of file mpiManager.cpp.

                                          :
  _size(0)
{ }

~MpiNonBlockingHelper()

olb::singleton::MpiNonBlockingHelper::~MpiNonBlockingHelper ( )

default

MpiNonBlockingHelper() [2/3]

olb::singleton::MpiNonBlockingHelper::MpiNonBlockingHelper ( MpiNonBlockingHelper && rhs )

default

MpiNonBlockingHelper() [3/3]

olb::singleton::MpiNonBlockingHelper::MpiNonBlockingHelper ( const MpiNonBlockingHelper & )

delete

Member Function Documentation

allocate()

void olb::singleton::MpiNonBlockingHelper::allocate

(

unsigned

i

)

Allocates memory.

Definition at line 1323 of file mpiManager.cpp.

{
  free();
  _mpiRequest.reset(new MPI_Request[n] { });
  _mpiStatus.reset(new MPI_Status[n] { });
  _size = n;
}

References free().

Here is the call graph for this function:

Here is the caller graph for this function:

free()

void olb::singleton::MpiNonBlockingHelper::free

(

)

Reset.

Definition at line 1331 of file mpiManager.cpp.

{
  _size = 0;
}

Here is the caller graph for this function:

get_mpiRequest()

MPI_Request * olb::singleton::MpiNonBlockingHelper::get_mpiRequest

(

int

i = 0

)

const

Get the specified request object.

Definition at line 1341 of file mpiManager.cpp.

{
  OLB_PRECONDITION(size_t(i) < _size);
  return &_mpiRequest[i];
}

References OLB_PRECONDITION.

Here is the caller graph for this function:

get_mpiStatus()

MPI_Status * olb::singleton::MpiNonBlockingHelper::get_mpiStatus

(

int

i = 0

)

const

Get the specified status object.

Definition at line 1347 of file mpiManager.cpp.

{
  OLB_PRECONDITION(size_t(i) < _size);
  return &_mpiStatus[i];
}

References OLB_PRECONDITION.

Here is the caller graph for this function:

get_size()

unsigned olb::singleton::MpiNonBlockingHelper::get_size

(

)

const

Returns the size of the vector _mpiRequest/_mpiStatus.

Definition at line 1336 of file mpiManager.cpp.

{
  return _size;
}

Here is the caller graph for this function:

isDone()

bool olb::singleton::MpiNonBlockingHelper::isDone

(

int

i

)

Definition at line 1363 of file mpiManager.cpp.

{
  int done;
  MPI_Test(get_mpiRequest(i), &done, MPI_STATUS_IGNORE);
  return done;
}

References get_mpiRequest().

Here is the call graph for this function:

operator=()

MpiNonBlockingHelper & olb::singleton::MpiNonBlockingHelper::operator= ( const MpiNonBlockingHelper & )

delete

start()

void olb::singleton::MpiNonBlockingHelper::start

(

int

i

)

Definition at line 1353 of file mpiManager.cpp.

{
  MPI_Start(get_mpiRequest(i));
}

References get_mpiRequest().

Here is the call graph for this function:

swap()

void olb::singleton::MpiNonBlockingHelper::swap

(

MpiNonBlockingHelper &

rhs

)

Swap method.

Definition at line 1316 of file mpiManager.cpp.

{
  std::swap(_size, rhs._size);
  std::swap(_mpiRequest, rhs._mpiRequest);
  std::swap(_mpiStatus, rhs._mpiStatus);
}

wait()

void olb::singleton::MpiNonBlockingHelper::wait

(

int

i

)

Definition at line 1358 of file mpiManager.cpp.

{
  MPI_Wait(get_mpiRequest(i), get_mpiStatus(i));
}

References get_mpiRequest(), and get_mpiStatus().

Here is the call graph for this function:

---

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

• src/communication/mpiManager.h
• src/communication/mpiManager.cpp