|
« Return to documentation listing
Table of Contents
MPI_Sizeof - Returns the size, in bytes, of the given type
USE MPI
! or the older form: INCLUDE ’mpif.h’
MPI_SIZEOF(X, SIZE, IERROR)
<type> X
INTEGER SIZE, IERROR
USE mpi_f08
MPI_Sizeof(x, size, ierror)
TYPE(*), DIMENSION(..) :: x
INTEGER, INTENT(OUT) :: size
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
- X
- A Fortran variable of numeric intrinsic type (choice).
- SIZE
- Size of machine representation of that type (integer).
- IERROR
- Error status (integer).
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/C++. However, if given an array argument, it returns
the size of the base element, not the size of the whole array.
This
function is not available in C/C++ because it is not necessary.
Almost
all MPI routines return an error value; C routines as the value of the
function and Fortran routines in the last argument. C++ functions do not
return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS,
then on error the C++ exception mechanism will be used to throw an MPI::Exception
object.
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.
Table of Contents
« Return to documentation listing
|
