MPICartrank(3OpenMPI) MPICartrank(3OpenMPI)

NAME
       MMPPIICCaarrttrraannkk   -  Determines process rank in communicator given Carte-
       sian location.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICartrank(MPIComm comm, int *coords, int *rank)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICARTRANK(COMM, COORDS, RANK, IERROR)
            INTEGER   COMM, COORDS(*), RANK, IERROR


CC++++ SSyynnttaaxx
       #include 
       int Cartcomm::Getcartrank(const int coords[]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Communicator with Cartesian structure (handle).

       coords    Integer  array  (of  size  ndims,  which   was   defined   by
                 MPICartcreate call) specifying the Cartesian coordinates of
                 a process.


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       rank      Rank of specified process (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       For  a  process  group   with   Cartesian   structure,   the   function
       MPICartrank  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.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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.


SEE ALSO
       MPICartcreate



Open MPI 1.2                    September 2006         MPICartrank(3OpenMPI)