MPI_Cart_map - Maps a process to Cartesian topology
       information


SYNOPSIS

       C:

            #include <mpi.h>

            int MPI_Cart_map ( comm_old, ndims, dims, periods, newrank )
            MPI_Comm comm_old;
            int      ndims;
            int     *dims;
            int     *periods;
            int     *newrank;

       C++:

            #include <mpi.h>

            int Cartcomm::Map(
            int               ndims,
            const int         dims[],
            const bool        periods[]) const

       Fortran:

            INCLUDE "mpif.h" (or USE MPI)

            INTEGER comm, ndims, dims(*), newrank,
            ierror
            LOGICAL periods(*)

            CALL MPI_CART_MAP(comm, ndims, dims(*),
            periods(*), newrank, ierror)


STANDARDS

       This release implements the MPI 1.2 standard, as
       documented by the MPI Forum in the spring 1997 release of
       MPI:  A Message Passing Interface Standard.


DESCRIPTION

       The MPI_Cart_map routine maps a process to Cartesian
       topology information.  This routine accepts the following
       parameters:

       comm_old  Specifies the input communicator (handle).

       ndims     Specifies the number of dimensions of Cartesian
                 structure (integer).

                 specifies the number of processes in each
                 coordinate direction.

       periods   Specifies a logical array of size ndims, which
                 specifies the periodicity specification in each
                 coordinate direction.

       newrank   Returns the reordered rank of the calling
                 process (integer).  If the calling process does
                 not belong to a grid, it returns a value of
                 MPI_UNDEFINED.

       ierror    Specifies the return code value for successful
                 completion, which is in MPI_SUCCESS.
                 MPI_SUCCESS is defined in the mpif.h file.


Man(1) output converted with man2html