mpi_comm_get_parent(3) [debian man page]

MPI_Comm_get_parent(3)							MPI						    MPI_Comm_get_parent(3)

NAME

       MPI_Comm_get_parent -  Return the parent communicator for this process

SYNOPSIS

       int MPI_Comm_get_parent(MPI_Comm *parent)

OUTPUT PARAMETER

       parent - the parent communicator (handle)

NOTES

       If  a  process was started with MPI_Comm_spawn or MPI_Comm_spawn_multiple , MPI_Comm_get_parent returns the parent intercommunicator of the
       current process. This parent intercommunicator is created implicitly inside of MPI_Init and  is	the  same  intercommunicator  returned	by
       MPI_Comm_spawn in the parents.

       If the process was not spawned, MPI_Comm_get_parent returns MPI_COMM_NULL .

       After the parent communicator is freed or disconnected, MPI_Comm_get_parent returns MPI_COMM_NULL .

THREAD AND INTERRUPT SAFETY

       This  routine  is  both	thread- and interrupt-safe.  This means that this routine may safely be used by multiple threads and from within a
       signal handler.

NOTES FOR FORTRAN

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument  list.   ierr
       is  an integer and has the same meaning as the return value of the routine in C.  In Fortran, MPI routines are subroutines, and are invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran  routines	in
       the  last  argument.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts the MPI
       job.  The error handler may  be	changed  with  MPI_Comm_set_errhandler	(for  communicators),  MPI_File_set_errhandler	(for  files),  and
       MPI_Win_set_errhandler  (for  RMA  windows).   The  MPI-1 routine MPI_Errhandler_set may be used but its use is deprecated.  The predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ).

LOCATION

       comm_get_parent.c

								     11/2/2007						    MPI_Comm_get_parent(3)

MPI_Comm_get_parent(3)						      LAM/MPI						    MPI_Comm_get_parent(3)

NAME

       MPI_Comm_get_parent -  Get the parent communicator of a spawned MPI rank

SYNOPSIS

       #include <mpi.h>
       int
       MPI_Comm_get_parent(MPI_Comm *parent)

OUTPUT PARAMETER

       comm   - parent communicator

NOTES FOR FORTRAN

       All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list.  ierr
       is an integer and has the same meaning as the return value of the routine in C.	In Fortran, MPI routines are subroutines, and are  invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

USAGE WITH IMPI EXTENSIONS

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

ERRORS

       If an error occurs in an MPI function, the current MPI error handler is called to handle it.  By default, this error handler aborts the MPI
       job.  The error handler may be changed with MPI_Errhandler_set ; the predefined error handler MPI_ERRORS_RETURN may be used to cause  error
       values  to  be  returned  (in  C and Fortran; this error handler is less useful in with the C++ MPI bindings.  The predefined error handler
       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value needs to be recovered).  Note that MPI does not guarantee that an MPI
       program can continue past an error.

       All  MPI  routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in
       the last argument.  The C++ bindings for MPI do not return error values; instead, error values are communicated by throwing  exceptions	of
       type MPI::Exception (but not by default).  Exceptions are only thrown if the error value is not MPI::SUCCESS
	.

       Note  that  if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return upon an error, there will be no way to recover
       what the actual error value was.
       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_ARG
	      - Invalid argument.  Some argument is invalid and is not identified by a specific error class.  This is typically a NULL pointer	or
	      other such error.

SEE ALSO

       MPI_Comm_spawn(3), MPI_Comm_spawn_multiple(3)

MORE INFORMATION

       For  more  information,	please	see the official MPI Forum web site, which contains the text of both the MPI-1 and MPI-2 standards.  These
       documents contain detailed information about each MPI function (most of which is not duplicated in these man pages).

       http://www.mpi-forum.org/

LOCATION

       cgetparent.c

LAM
/MPI 6.5.8							    11/10/2002						    MPI_Comm_get_parent(3)