MPI_Comm_get_parent(3)

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

NAME

6       MPI_Comm_get_parent  -   Get  the  parent communicator of a spawned MPI
7       rank
8

SYNOPSIS

10       #include <mpi.h>
11       int
12       MPI_Comm_get_parent(MPI_Comm *parent)
13

OUTPUT PARAMETER

15       comm   - parent communicator
16
17

NOTES FOR FORTRAN

19       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )  have
20       an  additional  argument ierr at the end of the argument list.  ierr is
21       an integer and has the same meaning as the return value of the  routine
22       in  C.   In Fortran, MPI routines are subroutines, and are invoked with
23       the call statement.
24
25       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
26       Fortran.
27
28

USAGE WITH IMPI EXTENSIONS

30       The  IMPI standard only supports MPI-1 functions.  Hence, this function
31       is currently not designed to operate within an IMPI job.
32
33

ERRORS

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

MORE INFORMATION

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

LOCATION

77       cgetparent.c
78
79
80
81LAM/MPI 7.1.2                      2/23/2006            MPI_Comm_get_parent(3)