1MPI_Get_elements(3)                 LAM/MPI                MPI_Get_elements(3)
2
3
4

NAME

6       MPI_Get_elements -  Returns the number of basic elements in a datatype
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Get_elements(MPI_Status *stat, MPI_Datatype dtype,
11                           int *count)
12

INPUT PARAMETERS

14       stat   - return status of receive operation (Status)
15       dtype  - datatype used by receive operation (handle)
16
17

OUTPUT PARAMETER

19       count  - number of received basic elements (integer)
20
21

NOTES

23       It is not legal to pass MPI_STATUS_IGNORE as stat to this function.
24
25       count will be set to MPI_UNDEFINED if the size of the datatype is zero.
26
27

NOTES FOR FORTRAN

29       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
30       an additional argument ierr at the end of the argument list.   ierr  is
31       an  integer and has the same meaning as the return value of the routine
32       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
33       the call statement.
34
35       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
36       Fortran.
37
38

ERRORS

40       If an error occurs in an MPI function, the current MPI error handler is
41       called  to  handle  it.   By default, this error handler aborts the MPI
42       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
43       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
44       values to be returned (in C and Fortran; this  error  handler  is  less
45       useful  in  with  the  C++  MPI bindings.  The predefined error handler
46       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
47       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
48       program can continue past an error.
49
50       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
51       value;  C routines as the value of the function and Fortran routines in
52       the last argument.  The C++ bindings for MPI do not return  error  val‐
53       ues;  instead,  error values are communicated by throwing exceptions of
54       type MPI::Exception (but not by default).  Exceptions are  only  thrown
55       if the error value is not MPI::SUCCESS .
56
57
58       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
59       functions will return upon an error, there will be no  way  to  recover
60       what the actual error value was.
61       MPI_SUCCESS
62              - No error; MPI routine completed successfully.
63       MPI_ERR_ARG
64              - Invalid argument.  Some argument is invalid and is not identi‐
65              fied by a specific  error  class.   This  is  typically  a  NULL
66              pointer or other such error.
67       MPI_ERR_TYPE
68              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
69              (see MPI_Type_commit ).
70
71

MORE INFORMATION

73       For more information, please see the official MPI Forum web site, which
74       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
75       ments contain detailed information about each  MPI  function  (most  of
76       which is not duplicated in these man pages).
77
78       http://www.mpi-forum.org/
79
80
81

ACKNOWLEDGEMENTS

83       The  LAM Team would like the thank the MPICH Team for the handy program
84       to generate man pages  ("doctext"  from  ftp://ftp.mcs.anl.gov/pub/sow‐
85       ing/sowing.tar.gz  ), the initial formatting, and some initial text for
86       most of the MPI-1 man pages.
87

LOCATION

89       getelem.c
90
91
92
93LAM/MPI 7.1.2                      2/23/2006               MPI_Get_elements(3)