MPICartdimget(3OpenMPI) MPICartdimget(3OpenMPI)

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


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICartdimget(MPIComm comm, int *ndims)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICARTDIMGET(COMM, NDIMS, IERROR)
            INTEGER   COMM, NDIMS, IERROR


CC++++ SSyynnttaaxx
       #include 
       int Cartcomm::Getdim() const


IINNPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator with Cartesian structure (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       ndims     Number of dimensions of the Cartesian structure (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICartdimget returns the  number  of  dimensions  of  the  Cartesian
       structure.


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




Open MPI 1.2                    September 2006       MPICartdimget(3OpenMPI)