MPIGraphmap(3OpenMPI) MPIGraphmap(3OpenMPI)

NAME
       MMPPIIGGrraapphhmmaapp  - Maps process to graph topology information.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIGraphmap(MPIComm comm, int nnodes, int *index,
            int *edges, int *newrank)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIGRAPHMAP(COMM, NNODES, INDEX, EDGES, NEWRANK, IERROR)
            INTEGER   COMM, NNODES, INDEX(*), EDGES(*), NEWRANK, IERROR


CC++++ SSyynnttaaxx
       #include 
       int Graphcomm::Map(int nnodes, const int index[],
            const int edges[]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Input communicator (handle).

       nnodes    Number of graph nodes (integer).

       index     Integer array specifying the graph structure, see  MPIGraph
                 create.

       edges     Integer array specifying the graph structure.


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       newrank   Reordered rank of the calling process; MPIUNDEFINED  if  the
                 calling process does not belong to graph (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICartmap  and  MPIGraphmap  can  be  used  to implement all other
       topology functions. In general they will not  be  called  by  the  user
       directly,  unless  he  or  she  is creating additional virtual topology
       capability other than that provided by MPI.


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
       MPICartmap




Open MPI 1.2                    September 2006         MPIGraphmap(3OpenMPI)