[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_Cart_get 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Cart_get\fP \- Retrieves Cartesian topology information associated with a communicator. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Cart_get(MPI_Comm\fI comm\fP, int\fI maxdims\fP, int\fI *dims\fP, int\fI *periods\fP, |
---|
| 13 | int\fI *coords\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | MPI_CART_GET(\fICOMM\fP, \fIMAXDIMS\fP, \fIDIMS\fP, \fIPERIODS\fP, \fICOORDS\fP, \fIIERROR\fP) |
---|
| 19 | INTEGER \fICOMM\fP, \fIMAXDIMS\fP, \fIDIMS\fP(*), \fICOORDS\fP(*), \fIIERROR\fP |
---|
| 20 | LOGICAL \fIPERIODS\fP(*) |
---|
| 21 | |
---|
| 22 | .SH C++ Syntax |
---|
| 23 | .nf |
---|
| 24 | #include <mpi.h> |
---|
| 25 | void Cartcomm::Get_topo(int \fImaxdims\fP, int \fIdims\fP[], |
---|
| 26 | bool \fIperiods\fP[], int \fIcoords\fP[]) const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETERS |
---|
| 29 | .ft R |
---|
| 30 | .TP 1i |
---|
| 31 | comm |
---|
| 32 | Communicator with Cartesian structure (handle). |
---|
| 33 | .TP 1i |
---|
| 34 | maxdims |
---|
| 35 | Length of vectors dims, periods, and coords in the calling program (integer). |
---|
| 36 | |
---|
| 37 | .SH OUTPUT PARAMETERS |
---|
| 38 | .ft R |
---|
| 39 | .TP 1i |
---|
| 40 | dims |
---|
| 41 | Number of processes for each Cartesian dimension (array of integers). |
---|
| 42 | .TP 1i |
---|
| 43 | periods |
---|
| 44 | Periodicity (true/false) for each Cartesian dimension (array of logicals). |
---|
| 45 | .TP 1i |
---|
| 46 | coords |
---|
| 47 | Coordinates of calling process in Cartesian structure (array of integers). |
---|
| 48 | .ft R |
---|
| 49 | .TP 1i |
---|
| 50 | IERROR |
---|
| 51 | Fortran only: Error status (integer). |
---|
| 52 | |
---|
| 53 | .SH DESCRIPTION |
---|
| 54 | .ft R |
---|
| 55 | The functions MPI_Cartdim_get and MPI_Cart_get return the Cartesian topology information that was associated with a communicator by MPI_Cart_create. |
---|
| 56 | |
---|
| 57 | .SH ERRORS |
---|
| 58 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
| 59 | .sp |
---|
| 60 | Before the error value is returned, the current MPI error handler is |
---|
| 61 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
| 62 | |
---|
| 63 | .SH SEE ALSO |
---|
| 64 | .ft R |
---|
| 65 | .sp |
---|
| 66 | .nf |
---|
| 67 | MPI_Cartdim_get |
---|
| 68 | MPI_Cart_create |
---|