1MPI_Dims_create(3) LAM/MPI MPI_Dims_create(3)
2
6 MPI_Dims_create - Creates a division of processors in a cartesian grid
7
9 #include <mpi.h>
10 int MPI_Dims_create(int nprocs, int ndims, int *dims)
11
13 nprocs - number of nodes in a grid (integer)
14 ndims - number of cartesian dimensions (integer)
15
18 dims - integer array of size ndims specifying the number of nodes in
19 each dimension
20
23 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
24 an additional argument ierr at the end of the argument list. ierr is
25 an integer and has the same meaning as the return value of the routine
26 in C. In Fortran, MPI routines are subroutines, and are invoked with
27 the call statement.
28 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
30 Fortran.
31
34 If an error occurs in an MPI function, the current MPI error handler is
35 called to handle it. By default, this error handler aborts the MPI
36 job. The error handler may be changed with MPI_Errhandler_set ; the
37 predefined error handler MPI_ERRORS_RETURN may be used to cause error
38 values to be returned (in C and Fortran; this error handler is less
39 useful in with the C++ MPI bindings. The predefined error handler
40 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
41 needs to be recovered). Note that MPI does not guarantee that an MPI
42 program can continue past an error.
43 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
45 value; C routines as the value of the function and Fortran routines in
46 the last argument. The C++ bindings for MPI do not return error val‐
47 ues; instead, error values are communicated by throwing exceptions of
48 type MPI::Exception (but not by default). Exceptions are only thrown
49 if the error value is not MPI::SUCCESS .
50 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
53 functions will return upon an error, there will be no way to recover
54 what the actual error value was.
55 MPI_SUCCESS
56 - No error; MPI routine completed successfully.
57 MPI_ERR_DIMS
58 - Illegal dimension argument. A dimension argument is null or
59 its length is less than or equal to zero.
60 MPI_ERR_ARG
61 - Invalid argument. Some argument is invalid and is not identi‐
62 fied by a specific error class. This is typically a NULL
63 pointer or other such error.
64 MPI_ERR_OTHER
65 - This error is returned when some part of the LAM/MPI implemen‐
66 tation is unable to acquire memory.
67
70 For more information, please see the official MPI Forum web site, which
71 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
72 ments contain detailed information about each MPI function (most of
73 which is not duplicated in these man pages).
74 http://www.mpi-forum.org/
76
80 The LAM Team would like the thank the MPICH Team for the handy program
81 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
82 ing/sowing.tar.gz ), the initial formatting, and some initial text for
83 most of the MPI-1 man pages.
84
86 dimscreate.c
87LAM/MPI 7.1.2 2/23/2006 MPI_Dims_create(3)