1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Cart_rank 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Cart_rank \fP \- Determines process rank in communicator given Cartesian location. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Cart_rank(MPI_Comm \fIcomm\fP, int\fI *coords\fP, int\fI *rank\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_CART_RANK(\fICOMM, COORDS, RANK, IERROR\fP) |
---|
18 | INTEGER \fICOMM, COORDS(*), RANK, IERROR\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | int Cartcomm::Get_cart_rank(const int \fIcoords\fP[]) const |
---|
24 | |
---|
25 | .SH INPUT PARAMETERS |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | comm |
---|
29 | Communicator with Cartesian structure (handle). |
---|
30 | .TP 1i |
---|
31 | coords |
---|
32 | Integer array (of size ndims, which was defined by MPI_Cart_create call) specifying the Cartesian coordinates of a process. |
---|
33 | |
---|
34 | .SH OUTPUT PARAMETER |
---|
35 | .ft R |
---|
36 | .TP 1i |
---|
37 | rank |
---|
38 | Rank of specified process (integer). |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | IERROR |
---|
42 | Fortran only: Error status (integer). |
---|
43 | |
---|
44 | .SH DESCRIPTION |
---|
45 | .ft R |
---|
46 | For a process group with Cartesian structure, the function MPI_Cart_rank |
---|
47 | translates the logical process coordinates to process ranks as they are used by the point-to-point routines. For dimension i with periods(i) = true, if the coordinate, coords(i), is out of range, that is, coords(i) < 0 or coords(i) >= dims(i), it is shifted back to the interval 0 =< coords(i) < dims(i) automatically. Out-of-range coordinates are erroneous for nonperiodic dimensions. |
---|
48 | |
---|
49 | .SH ERRORS |
---|
50 | 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. |
---|
51 | .sp |
---|
52 | Before the error value is returned, the current MPI error handler is |
---|
53 | 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. |
---|
54 | |
---|
55 | .SH SEE ALSO |
---|
56 | .sp |
---|
57 | MPI_Cart_create |
---|