MPITopotest(3OpenMPI) MPITopotest(3OpenMPI)

NAME
       MMPPIITTooppootteesstt  -  Determines  the  type of topology (if any) associated
       with a communicator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITopotest(MPIComm comm, int *toptype)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITOPOTEST(COMM, TOPTYPE, IERROR)
            INTEGER   COMM, TOPTYPE, IERROR


CC++++ SSyynnttaaxx
       #include 
       int Comm::Gettopology() const


IINNPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       toptype  Topology type of communicator comm (choice).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The function  MPITopotest  returns  the  type  of  topology  that  is
       assigned to a communicator.

       The output value toptype is one of the following:

           MPIGRAPH       graph topology
           MPICART        Cartesian topology
           MPIUNDEFINED   no topology


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
       MPIGraphcreate
       MPICartcreate




Open MPI 1.2                    September 2006         MPITopotest(3OpenMPI)