MPI_Cartdim_get(3)

NAME
MPI_Cartdim_get - Returns the number of dimensions in the cartesian communicator

SYNOPSIS
#include <mpi.h>
int MPI_Cartdim_get(MPI_Comm comm, int *ndims);

#include <pmpi.h>
int PMPI_Cartdim_get(MPI_Comm comm, int *ndims);

#include <mpi.h>
int MPI::Cartcomm::Get_dim(void) const;

INCLUDE 'mpif.h'
MPI_CARTDIM_GET(comm, ndims, ierr)
INTEGER  comm ,  ndims ,  ierr

INPUT PARAMETER
comm
    - cartesian communicator (handle)

OUTPUT PARAMETER
ndims
    - the number of dimensions in the cartesian communicator (integer).

DESCRIPTION
The MPI_Cartdim_get() function is used to obtain the number of dimensions in the cartesian communicator. In C++ the number of dimensions, ndims is the return value. The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Cartdim_get() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.
MPI_SUCCESS
    - No error;
MPI_ERR_COMM
    - Invalid communicator;
MPI_ERR_TOPOLOGY
    - Not a cartesian communicator;
MPI_ERR_DIMS
    - Invalid output pointer.

SEE ALSO
MPI_Cart_create(3), MPI_Dims_create(3), MPI_Cart_get(3), MPI_Cart_map(3), MPI_Graph_create(3), MPI_Graphdims_get(3), MPI_Comm_free(3)