root / man / man3 / HPL_grid_info.3 @ 1
Historique | Voir | Annoter | Télécharger (1,45 ko)
| 1 |
.TH HPL_grid_info 3 "September 10, 2008" "HPL 2.0" "HPL Library Functions" |
|---|---|
| 2 |
.SH NAME |
| 3 |
HPL_grid_info \- Retrieve grid information. |
| 4 |
.SH SYNOPSIS |
| 5 |
\fB\&#include "hpl.h"\fR |
| 6 |
|
| 7 |
\fB\&int\fR |
| 8 |
\fB\&HPL_grid_info(\fR |
| 9 |
\fB\&const HPL_T_grid *\fR |
| 10 |
\fI\&GRID\fR, |
| 11 |
\fB\&int *\fR |
| 12 |
\fI\&NPROW\fR, |
| 13 |
\fB\&int *\fR |
| 14 |
\fI\&NPCOL\fR, |
| 15 |
\fB\&int *\fR |
| 16 |
\fI\&MYROW\fR, |
| 17 |
\fB\&int *\fR |
| 18 |
\fI\&MYCOL\fR |
| 19 |
\fB\&);\fR |
| 20 |
.SH DESCRIPTION |
| 21 |
\fB\&HPL_grid_info\fR |
| 22 |
returns the grid shape and the coordinates in the grid |
| 23 |
of the calling process. Successful completion is indicated by the |
| 24 |
returned error code MPI_SUCCESS. Other error codes depend on the MPI |
| 25 |
implementation. |
| 26 |
.SH ARGUMENTS |
| 27 |
.TP 8 |
| 28 |
GRID (local input) const HPL_T_grid * |
| 29 |
On entry, GRID points to the data structure containing the |
| 30 |
process grid information. |
| 31 |
.TP 8 |
| 32 |
NPROW (global output) int * |
| 33 |
On exit, NPROW specifies the number of process rows in the |
| 34 |
grid. NPROW is at least one. |
| 35 |
.TP 8 |
| 36 |
NPCOL (global output) int * |
| 37 |
On exit, NPCOL specifies the number of process columns in |
| 38 |
the grid. NPCOL is at least one. |
| 39 |
.TP 8 |
| 40 |
MYROW (global output) int * |
| 41 |
On exit, MYROW specifies my row process coordinate in the |
| 42 |
grid. MYROW is greater than or equal to zero and less than |
| 43 |
NPROW. |
| 44 |
.TP 8 |
| 45 |
MYCOL (global output) int * |
| 46 |
On exit, MYCOL specifies my column process coordinate in the |
| 47 |
grid. MYCOL is greater than or equal to zero and less than |
| 48 |
NPCOL. |
| 49 |
.SH SEE ALSO |
| 50 |
.BR HPL_pnum \ (3), |
| 51 |
.BR HPL_grid_init \ (3), |
| 52 |
.BR HPL_grid_exit \ (3). |