MPI_Cartdim_get(3)

MPI_Cartdim_get - Retrieves Cartesian topology information associated with a communicator

As shipped in IRIX 6.5.30. Added in IRIX 6.5.19.

NAME
     MPI_Cartdim_get - Retrieves Cartesian topology information associated
     with a communicator

SYNOPSIS
     C:

          #include <mpi.h>

          int MPI_Cartdim_get ( comm, ndims )
          MPI_Comm  comm;
          int      *ndims;


     C++:

          #include <mpi.h>

          int Cartcomm::Get_dim() const


     Fortran:

          INCLUDE "mpif.h" (or USE MPI)

          INTEGER comm, ndims, ierror

          CALL MPI_CARTDIM_GET(comm, ndims, ierror)


STANDARDS
     This release implements the MPI 1.2 standard, as documented by the MPI
     Forum in the spring 1997 release of MPI:  A Message Passing Interface
     Standard.

DESCRIPTION
     The MPI_Cartdim_get routine retrieves Cartesian topology information
     associated with a communicator.  This routine accepts the following
     parameters:

     comm      Specifies a communicator with Cartesian structure (handle)

     ndims     Returns the number of dimensions of the Cartesian structure
               (integer)

     ierror    Specifies the return code value for successful completion,
               which is in MPI_SUCCESS.  MPI_SUCCESS is defined in the mpif.h
               file.