mpi_comm_set_name(3openmpi) [osx man page]

MPI_Comm_set_name(3OpenMPI)											       MPI_Comm_set_name(3OpenMPI)

NAME

       MPI_Comm_set_name - Associates a name with a communicator.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Comm_set_name(MPI_Comm comm, char *comm_name)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_SET_NAME(COMM, COMM_NAME, IERROR)
	    INTEGER   COMM, IERROR
	    CHARACTER*(*) COMM_NAME

C++ Syntax
       #include <mpi.h>
       void MPI::Comm::Set_name(const char* comm_name)

INPUT
/OUTPUT PARAMETER
       comm	 Communicator whose identifier is to be set (handle).

INPUT PARAMETER

       comm_name Character string to be used as the identifier for the communicator (string).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Comm_set_name allows a user to associate a name string with a communicator. The character string that is passed to MPI_Comm_set_name is
       saved inside the MPI library (so it can be freed by the caller immediately after the call, or allocated on the stack).  Leading	spaces	in
       name are significant, but trailing ones are not.

       MPI_Comm_set_name  is  a  local (noncollective) operation, which affects only the name of the communicator as seen in the process that made
       the MPI_Comm_set_name call. There is no requirement that the same (or any) name be assigned to a communicator in  every	process  where	it
       exists.

       The  length of the name that can be stored is limited to the value of MPI_MAX_OBJECT_NAME in Fortran and MPI_MAX_OBJECT_NAME-1 in C and C++
       (to allow for the null terminator). Attempts to set names longer than this will result in truncation of the name. MPI_MAX_OBJECT_NAME  must
       have a value of at least 64.

NOTES

       Since  MPI_Comm_set_name  is  provided  to  help debug code, it is sensible to give the same name to a communicator in all of the processes
       where it exists, to avoid confusion.

       Regarding name length, under circumstances of store exhaustion, an attempt to set a name of any length could fail; therefore, the value	of
       MPI_MAX_OBJECT_NAME  should be viewed only as a strict upper bound on the name length, not a guarantee that setting names of less than this
       length will always succeed.

ERRORS

       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::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 ALSO

       MPI_Comm_get_name

Open MPI 1.2							  September 2006				       MPI_Comm_set_name(3OpenMPI)

Check Out this Related Man Page

MPI_Comm_disconnect(3OpenMPI)											     MPI_Comm_disconnect(3OpenMPI)

NAME

       MPI_Comm_disconnect - Deallocates communicator object and sets handle to MPI_COMM_NULL.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Comm_disconnect(MPI_Comm *comm)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_COMM_DISCONNECT(COMM, IERROR)
	    INTEGER   COMM, IERROR

C++ Syntax
       #include <mpi.h>
       void MPI::Comm::Disconnect()

INPUT
/OUTPUT PARAMETER
       comm	 Communicator (handle).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Comm_disconnect  waits  for all pending communication on comm to complete internally, deallocates the communicator object, and sets the
       handle to MPI_COMM_NULL. It is a collective operation.

       It may not be called with the communicator MPI_COMM_WORLD or MPI_COMM_SELF.

       MPI_Comm_disconnect may be called only if all communication is complete and matched, so that buffered data can be delivered to its destina-
       tion. This requirement is the same as for MPI_Finalize.

       MPI_Comm_disconnect  has  the same action as MPI_Comm_free, except that it waits for pending communication to finish internally and enables
       the guarantee about the behavior of disconnected processes.

NOTES

       To disconnect two processes you may need to call MPI_Comm_disconnect, MPI_Win_free, and MPI_File_close to remove  all  communication  paths
       between	the  two processes. Note that it may be necessary to disconnect several communicators (or to free several windows or files) before
       two processes are completely independent.

ERRORS

       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::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 ALSO

       MPI_Comm_connect
       MPI_Comm_accept

Open MPI 1.2							  September 2006				     MPI_Comm_disconnect(3OpenMPI)

Linux and UNIX Man Pages

mpi_comm_set_name(3openmpi) [osx man page]

Check Out this Related Man Page