A Virtual MPI communication lawyer object.
More...
Classes |
struct | sVmpi |
| Class Vmpi: Definition. More...
|
Files |
file | vmpi.h |
| Class Vmpi: a Virtual MPI communication layer object.
|
Typedefs |
typedef struct sVmpi | Vmpi |
| Declaration of the Vmpi class as the Vmpi structure.
|
Functions |
int | Vmpi_init (int *argc, char ***argv) |
| The Vmp initializer.
|
int | Vmpi_finalize (void) |
| The Vmp finalizer.
|
Vmpi * | Vmpi_ctor (void) |
| The Vmpi constructor.
|
void | Vmpi_dtor (Vmpi **thee) |
| The Vmpi destructor.
|
int | Vmpi_rank (Vmpi *thee) |
| Return my processor ID.
|
int | Vmpi_size (Vmpi *thee) |
| Return the number of processors involved.
|
int | Vmpi_barr (Vmpi *thee) |
| An MPI barrier.
|
int | Vmpi_send (Vmpi *thee, int des, char *buf, int bufsize) |
| An MPI blocking send.
|
int | Vmpi_recv (Vmpi *thee, int src, char *buf, int bufsize) |
| An MPI blocking receive.
|
int | Vmpi_bcast (Vmpi *thee, char *buf, int bufsize) |
| An MPI broadcast.
|
int | Vmpi_reduce (Vmpi *thee, char *sbuf, char *rbuf, int bufsize) |
| An MPI reduce.
|
int | Vmpi_isend (Vmpi *thee, int des, char *buf, int bufsize) |
| An MPI non-blocking send.
|
Detailed Description
A Virtual MPI communication lawyer object.
Typedef Documentation
Declaration of the Vmpi class as the Vmpi structure.
- Author:
- Michael Holst
Function Documentation
int Vmpi_barr |
( |
Vmpi * |
thee |
) |
|
An MPI barrier.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
int Vmpi_bcast |
( |
Vmpi * |
thee, |
|
|
char * |
buf, |
|
|
int |
bufsize | |
|
) |
| | |
An MPI broadcast.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
| buf | buffer containing message |
| bufsize | number of items (of declared type) in buffer |
The Vmpi constructor.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
void Vmpi_dtor |
( |
Vmpi ** |
thee |
) |
|
The Vmpi destructor.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- None
- Parameters:
-
| thee | Pointer to pointer of the Vmpi object |
int Vmpi_finalize |
( |
void |
|
) |
|
The Vmp finalizer.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
int Vmpi_init |
( |
int * |
argc, |
|
|
char *** |
argv | |
|
) |
| | |
The Vmp initializer.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| argc | number of the command line arguments |
| argv | the command line arguments |
int Vmpi_isend |
( |
Vmpi * |
thee, |
|
|
int |
des, |
|
|
char * |
buf, |
|
|
int |
bufsize | |
|
) |
| | |
An MPI non-blocking send.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
| des | rank of receiving processor |
| buf | buffer containing message |
| bufsize | number of items (of declared type) in buffer |
int Vmpi_rank |
( |
Vmpi * |
thee |
) |
|
Return my processor ID.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
int Vmpi_recv |
( |
Vmpi * |
thee, |
|
|
int |
src, |
|
|
char * |
buf, |
|
|
int |
bufsize | |
|
) |
| | |
An MPI blocking receive.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
| src | rank of receiving processor |
| buf | buffer containing message |
| bufsize | number of items (of declared type) in buffer |
int Vmpi_reduce |
( |
Vmpi * |
thee, |
|
|
char * |
sbuf, |
|
|
char * |
rbuf, |
|
|
int |
bufsize | |
|
) |
| | |
An MPI reduce.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
| sbuf | address of send buffer (choice) |
| rbuf | address of receiving buffer (choice) |
| bufsize | number of items (of declared type) in buffer |
int Vmpi_send |
( |
Vmpi * |
thee, |
|
|
int |
des, |
|
|
char * |
buf, |
|
|
int |
bufsize | |
|
) |
| | |
An MPI blocking send.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |
| des | rank of receiving processor |
| buf | buffer containing message |
| bufsize | number of items (of declared type) in buffer |
int Vmpi_size |
( |
Vmpi * |
thee |
) |
|
Return the number of processors involved.
- Author:
- Michael Holst
- Note:
- Class Vmpi: Non-inlineable method (vmpi.c)
- Returns:
- Success enumeration
- Parameters:
-
| thee | Pointer to the Vmpi object |