MPIGet(3OpenMPI) MPIGet(3OpenMPI)

NAME
       MMPPIIGGeett - Copies data from the target memory to the origin.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       MPIGet(void *originaddr, int origincount, MPIDatatype
            origindatatype, int targetrank, MPIAint targetdisp,
            int targetcount, MPIDatatype targetdatatype, MPIWin win)


FFoorrttrraann SSyynnttaaxx ((sseeee FFOORRTTRRAANN 7777 NNOOTTEESS))
       INCLUDE 'mpif.h'
       MPIGET(ORIGINADDR, ORIGINCOUNT, ORIGINDATATYPE, TARGETRANK,
            TARGETDISP, TARGETCOUNT, TARGETDATATYPE, WIN, IERROR)
             ORIGINADDR(*)
            INTEGER(KIND=MPIADDRESSKIND) TARGETDISP
            INTEGER ORIGINCOUNT, ORIGINDATATYPE, TARGETRANK,
            TARGETCOUNT, TARGETDATATYPE, WIN, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Win::Get(const void *originaddr, int origincount,
            const MPI::Datatype& origindatatype, int targetrank,
            MPI::Aint targetdisp, int targetcount,
            const MPI::Datatype& targetdatatype) const


IINNPPUUTT PPAARRAAMMEETTEERRSS
       originaddr
                 Initial address of origin buffer (choice).

       origincount
                 Number of entries in origin buffer (nonnegative integer).

       origindatatype
                 Data type of each entry in origin buffer (handle).

       targetrank
                 Rank of target (nonnegative integer).

       targetdisp
                 Displacement from window start to the beginning of the target
                 buffer (nonnegative integer).

       targetcount
                 Number of entries in target buffer (nonnegative integer).

       target datatype
                 datatype of each entry in target buffer (handle)

       win       window object used for communication (handle)


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIGet copies data from the target memory to the  origin,  similar  to
       MPIPut,  except  that  the direction of data transfer is reversed. The
       origindatatype may not  specify  overlapping  entries  in  the  origin
       buffer.  The  target buffer must be contained within the target window,
       and the copied data must fit, without truncation, in the origin buffer.
       Only processes within the same node can access the target window.



FFOORRTTRRAANN 7777 NNOOTTEESS
       The MPI standard prescribes portable Fortran syntax for the TARGETDISP
       argument only for Fortran 90. FORTRAN 77 users may use the non-portable
       syntax

            INTEGER*MPIADDRESSKIND TARGETDISP

       where  MPIADDRESSKIND  is  a constant defined in mpif.h and gives the
       length of the declared integer in bytes.


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
       MPIPut




Open MPI 1.2                    September 2006               MPIGet(3OpenMPI)