MPICartget(3OpenMPI) MPICartget(3OpenMPI)

NAME
       MMPPIICCaarrttggeett  -   Retrieves  Cartesian  topology information associated
       with a communicator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICartget(MPIComm comm, int maxdims, int *dims, int *periods,
            int *coords)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICARTGET(COMM, MAXDIMS, DIMS, PERIODS, COORDS, IERROR)
            INTEGER   COMM, MAXDIMS, DIMS(*), COORDS(*), IERROR
            LOGICAL   PERIODS(*)


CC++++ SSyynnttaaxx
       #include 
       void Cartcomm::Gettopo(int maxdims, int dims[],
            bool periods[], int coords[]) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       comm      Communicator with Cartesian structure (handle).

       maxdims   Length of vectors dims, periods, and coords  in  the  calling
                 program (integer).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       dims      Number  of  processes  for each Cartesian dimension (array of
                 integers).

       periods   Periodicity (true/false) for each Cartesian dimension  (array
                 of logicals).

       coords    Coordinates  of calling process in Cartesian structure (array
                 of integers).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       The functions MPICartdimget and  MPICartget  return  the  Cartesian
       topology  information  that  was  associated  with  a  communicator  by
       MPICartcreate.


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



Open MPI 1.2                    September 2006          MPICartget(3OpenMPI)