MPIAllocmem(3OpenMPI) MPIAllocmem(3OpenMPI)

NAME
       MMPPIIAAllllooccmmeemm  - Allocates a specified memory segment.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIAllocmem(MPIAint size, MPIInfo info, void *baseptr)


FFoorrttrraann SSyynnttaaxx ((sseeee FFOORRTTRRAANN NNOOTTEESS))
       INCLUDE 'mpif.h'
       MPIALLOCMEM(SIZE, INFO, BASEPTR, IERROR)
            INTEGER INFO, IERROR
            INTEGER(KIND=MPIADDRESSKIND) SIZE, BASEPTR


CC++++ SSyynnttaaxx
       #include 
       void* MPI::Allocmem(MPI::Aint size, const MPI::Info& info)


IINNPPUUTT PPAARRAAMMEETTEERRSS
       size      Size of memory segment in bytes (nonnegative integer).

       info      Info argument (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       baseptr   Pointer to beginning of memory segment allocated.

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIAllocmem  allocates  size bytes of memory. The starting address of
       this memory is returned in the variable base.



FFOORRTTRRAANN NNOOTTEESS
       There is no portable FORTRAN 77 syntax for using MPIAllocmem.   There
       is  no  portable  Fortran  syntax  for  using  pointers  returned  from
       MPIAllocmem. However, MPIAllocmem can be used with Sun Fortran com-
       pilers.

       From  FORTRAN  77,  you can use the following non-standard declarations
       for the SIZE and BASEPTR arguments:
                  INCLUDE "mpif.h"
                  INTEGER*MPIADDRESSKIND SIZE, BASEPTR

       From either FORTRAN 77 or Fortran 90, you can use "Cray  pointers"  for
       the  BASEPTR  argument. Cray pointers are described further in the For-
       tran User's Guide and are supported by  many  Fortran  compilers.   For
       example,

                  INCLUDE "mpif.h"
                  REAL*4 A(100,100)
                  POINTER (BASEPTR, A)
                  INTEGER*MPIADDRESSKIND SIZE

                  SIZE = 4 * 100 * 100
                  CALL MPIALLOCMEM(SIZE,MPIINFONULL,BASEPTR,IERR)

                  ! use A

                  CALL MPIFREEMEM(A, IERR)


EERRRROORRSS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last  argument.  C++  func-
       tions  do  not  return  errors.  If the default error handler is set to
       MPI::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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 ALSO
       MPIFreemem



Open MPI 1.2                    September 2006         MPIAllocmem(3OpenMPI)