DragonFly On-Line Manual Pages
MPI_Cart_shift(3) MPI MPI_Cart_shift(3)
MPI_Cart_shift - Returns the shifted source and destination ranks,
given a shift direction and amount
int MPI_Cart_shift(MPI_Comm comm, int direction, int displ, int *source,
comm - communicator with cartesian structure (handle)
- coordinate dimension of shift (integer)
displ - displacement (> 0: upwards shift, < 0: downwards shift)
source - rank of source process (integer)
dest - rank of destination process (integer)
The direction argument is in the range [0,n-1] for an n-dimensional
THREAD AND INTERRUPT SAFETY
This routine is both thread- and interrupt-safe. This means that this
routine may safely be used by multiple threads and from within a signal
NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
an additional argument ierr at the end of the argument list. ierr is
an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with
the call statement.
All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
value; C routines as the value of the function and Fortran routines in
the last argument. Before the value is returned, the current MPI error
handler is called. By default, this error handler aborts the MPI job.
The error handler may be changed with MPI_Comm_set_errhandler (for
communicators), MPI_File_set_errhandler (for files), and
MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine
MPI_Errhandler_set may be used but its use is deprecated. The
predefined error handler MPI_ERRORS_RETURN may be used to cause error
values to be returned. Note that MPI does not guarentee that an MPI
program can continue past an error; however, MPI implementations will
attempt to continue whenever possible.
- No error; MPI routine completed successfully.
- Invalid topology. Either there is no topology associated with
this communicator, or it is not the correct type (e.g., MPI_CART
when expecting MPI_GRAPH ).
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in MPI_Comm_rank ).
- Invalid argument. Some argument is invalid and is not
identified by a specific error class (e.g., MPI_ERR_RANK ).