MpiBackend Class Reference

Represents a Message Passing Interface (MPI) implementation backend. More...

#include <MpiBackend.h>

Inheritance diagram for MpiBackend:

Public Types
typedef int	Result
	Result code. More...

Public Member Functions
virtual Result	initialize (int *argc, char ***argv)=0
	Initialize the backend. More...
virtual Result	terminate ()=0
	Terminate the backend. More...
virtual Result	getCommRank (MPI_Comm comm, int *rank)=0
	Retrieve communication rank (core id) More...
virtual Result	getCommSize (MPI_Comm comm, int *size)=0
	Retrieve communication size (total cores) More...
virtual Result	send (const void *buf, int count, MPI_Datatype datatype, int dest, int tag, MPI_Comm comm)=0
	Synchronous send data. More...
virtual Result	receive (void *buf, int count, MPI_Datatype datatype, int source, int tag, MPI_Comm comm, MPI_Status *status)=0
	Synchronous receive data. More...

Additional Inherited Members
Static Public Member Functions inherited from AbstractFactory< MpiBackend >
static MpiBackend *	create ()
	Abstract function to create an instance of T. More...

Detailed Description

Represents a Message Passing Interface (MPI) implementation backend.

Definition at line 36 of file MpiBackend.h.

Member Typedef Documentation

Result

typedef int MpiBackend::Result

Result code.

The same MPI_* values of mpi.h are used for Result values

See also

mpi.h

Definition at line 47 of file MpiBackend.h.

Member Function Documentation

getCommRank()

virtual Result MpiBackend::getCommRank ( MPI_Comm  comm, int *  rank  )

pure virtual

Retrieve communication rank (core id)

Parameters

comm	Communication reference
rank	Output the communication rank number

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Comm_rank().

getCommSize()

virtual Result MpiBackend::getCommSize ( MPI_Comm  comm, int *  size  )

pure virtual

Retrieve communication size (total cores)

Parameters

comm	Communication reference
size	Output the communication size

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Comm_size().

initialize()

virtual Result MpiBackend::initialize ( int *  argc, char ***  argv  )

pure virtual

Initialize the backend.

Parameters

argc	Argument count pointer
argv	Argument values array pointer

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Init().

receive()

virtual Result MpiBackend::receive ( void *  buf, int  count, MPI_Datatype  datatype, int  source, int  tag, MPI_Comm  comm, MPI_Status *  status  )

pure virtual

Synchronous receive data.

Parameters

buf	Output data buffer
count	Number of data items
datatype	Type of data
source	Source to receive data from (core id)
tag	Optional data identifier to receive
comm	Communication reference
status	Output the MPI status

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Recv().

send()

virtual Result MpiBackend::send ( const void *  buf, int  count, MPI_Datatype  datatype, int  dest, int  tag, MPI_Comm  comm  )

pure virtual

Synchronous send data.

Parameters

buf	Input data buffer
count	Number of data items
datatype	Type of data
dest	Destination to send to (core id)
tag	Optional data identifier to send
comm	Communication reference

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Send().

terminate()

virtual Result MpiBackend::terminate ( )

pure virtual

Terminate the backend.

Returns

Result code

Implemented in MpiHost, and MpiTarget.

Referenced by MPI_Finalize().

---

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

• lib/libmpi/MpiBackend.h