1MPI_Type_create_subarray(3) LAM/MPI MPI_Type_create_subarray(3)
2
6 MPI_Type_create_subarray - Create local array derived datatype
7
9 #include <mpi.h>
10 int
11 MPI_Type_create_subarray(int ndims, int *sizes, int *subsizes,
12 int *starts, int order,
13 MPI_Datatype oldtype, MPI_Datatype *newtype)
14
16 ndims - Number of array dimensions
17 sizes - Number of elements of type oldtype in each dimension of the
18 full array
19 subsizes
20 - Number of elements of type oldtype in each dimension of the
21 subarray
22 starts - Starting coordinates of the subarray in each dimension
23 order - array storage order flag
24 oldtype
25 - array element datatype
26
29 newtype
30 - new datatype
31
34 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
35 an additional argument ierr at the end of the argument list. ierr is
36 an integer and has the same meaning as the return value of the routine
37 in C. In Fortran, MPI routines are subroutines, and are invoked with
38 the call statement.
39 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
41 Fortran.
42
45 If an error occurs in an MPI function, the current MPI error handler is
46 called to handle it. By default, this error handler aborts the MPI
47 job. The error handler may be changed with MPI_Errhandler_set ; the
48 predefined error handler MPI_ERRORS_RETURN may be used to cause error
49 values to be returned (in C and Fortran; this error handler is less
50 useful in with the C++ MPI bindings. The predefined error handler
51 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
52 needs to be recovered). Note that MPI does not guarantee that an MPI
53 program can continue past an error.
54 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
56 value; C routines as the value of the function and Fortran routines in
57 the last argument. The C++ bindings for MPI do not return error val‐
58 ues; instead, error values are communicated by throwing exceptions of
59 type MPI::Exception (but not by default). Exceptions are only thrown
60 if the error value is not MPI::SUCCESS .
61 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
64 functions will return upon an error, there will be no way to recover
65 what the actual error value was.
66 MPI_SUCCESS
67 - No error; MPI routine completed successfully.
68 MPI_ERR_ARG
69 - Invalid argument. Some argument is invalid and is not identi‐
70 fied by a specific error class. This is typically a NULL
71 pointer or other such error.
72 MPI_ERR_TYPE
73 - Invalid datatype argument. May be an uncommitted MPI_Datatype
74 (see MPI_Type_commit ).
75 MPI_ERR_OTHER
76 - Other error; use MPI_Error_string to get more information
77 about this error code.
78
81 For more information, please see the official MPI Forum web site, which
82 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
83 ments contain detailed information about each MPI function (most of
84 which is not duplicated in these man pages).
85 http://www.mpi-forum.org/
87
89 tsubarray.c
90LAM/MPI 7.1.2 2/23/2006 MPI_Type_create_subarray(3)