1MPI_Cart_shift(3) LAM/MPI MPI_Cart_shift(3)
2
6 MPI_Cart_shift - Returns the shifted source and destination ranks,
7 given a shift direction and amount
8
10 #include <mpi.h>
11 int MPI_Cart_shift(MPI_Comm comm, int dim, int disp,
12 int *psrc, int *pdest)
13
15 comm - communicator with cartesian structure (handle)
16 dim - coordinate dimension of shift (integer)
17 disp - displacement (> 0: upwards shift, < 0: downwards shift) (inte‐
18 ger)
19
22 psrc - rank of source process (integer)
23 pdest - rank of destination process (integer)
24
27 The dim argument is in the range [0,n-1] for an n-dimensional Cartesian
28 mesh.
29
32 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
33 an additional argument ierr at the end of the argument list. ierr is
34 an integer and has the same meaning as the return value of the routine
35 in C. In Fortran, MPI routines are subroutines, and are invoked with
36 the call statement.
37 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
39 Fortran.
40
43 If an error occurs in an MPI function, the current MPI error handler is
44 called to handle it. By default, this error handler aborts the MPI
45 job. The error handler may be changed with MPI_Errhandler_set ; the
46 predefined error handler MPI_ERRORS_RETURN may be used to cause error
47 values to be returned (in C and Fortran; this error handler is less
48 useful in with the C++ MPI bindings. The predefined error handler
49 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
50 needs to be recovered). Note that MPI does not guarantee that an MPI
51 program can continue past an error.
52 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
54 value; C routines as the value of the function and Fortran routines in
55 the last argument. The C++ bindings for MPI do not return error val‐
56 ues; instead, error values are communicated by throwing exceptions of
57 type MPI::Exception (but not by default). Exceptions are only thrown
58 if the error value is not MPI::SUCCESS .
59 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
62 functions will return upon an error, there will be no way to recover
63 what the actual error value was.
64 MPI_SUCCESS
65 - No error; MPI routine completed successfully.
66 MPI_ERR_TOPOLOGY
67 - Invalid topology. Either there is no topology associated with
68 this communicator, or it is not the correct type (e.g., MPI_CART
69 when expecting MPI_GRAPH ).
70 MPI_ERR_DIMS
71 - Illegal dimension argument. A dimension argument is null or
72 its length is less than or equal to zero.
73 MPI_ERR_COMM
74 - Invalid communicator. A common error is to use a null commu‐
75 nicator in a call (not even allowed in MPI_Comm_rank ).
76 MPI_ERR_ARG
77 - Invalid argument. Some argument is invalid and is not identi‐
78 fied by a specific error class. This is typically a NULL
79 pointer or other such error.
80
83 For more information, please see the official MPI Forum web site, which
84 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
85 ments contain detailed information about each MPI function (most of
86 which is not duplicated in these man pages).
87 http://www.mpi-forum.org/
89
93 The LAM Team would like the thank the MPICH Team for the handy program
94 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
95 ing/sowing.tar.gz ), the initial formatting, and some initial text for
96 most of the MPI-1 man pages.
97
99 cartshift.c
100LAM/MPI 7.1.2 2/23/2006 MPI_Cart_shift(3)