17.2.328. MPI_Sizeof

MPI_Sizeof - Returns the size, in bytes, of the given type

17.2.328.1. SYNTAX

17.2.328.1.1. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_SIZEOF(X, SIZE, IERROR)
<type>       X
INTEGER      SIZE, IERROR

17.2.328.1.2. Fortran 2008 Syntax

USE mpi_f08
MPI_Sizeof(x, size, ierror)
     TYPE(*), DIMENSION(..) :: x
     INTEGER, INTENT(OUT) :: size
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.328.2. INPUT PARAMETER

  • X: A Fortran variable of numeric intrinsic type (choice).

17.2.328.3. OUTPUT PARAMETERS

  • SIZE: Size of machine representation of that type (integer).

  • IERROR: Error status (integer).

17.2.328.4. DESCRIPTION

MPI_Sizeof returns the size (in bytes) of the machine representation of the given variable. It is a generic Fortran type and has a Fortran binding only. This routine is similar to the sizeof builtin in C. However, if given an array argument, it returns the size of the base element, not the size of the whole array.

17.2.328.5. NOTES

This function is not available in C because it is not necessary.

17.2.328.6. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See the MPI man page for a full list of MPI error codes.