Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MPI_Comm_set_name(3)		      MPI		  MPI_Comm_set_name(3)

NAME
       MPI_Comm_set_name -  Sets the print name	for a communicator

SYNOPSIS
       int MPI_Comm_set_name(MPI_Comm comm, MPICH2_CONST char *comm_name)

INPUT PARAMETERS
       MPI_Comm	comm
	      -	communicator to	name (handle)
       char *comm_name
	      -	Name for communicator

THREAD AND INTERRUPT SAFETY
       This  routine  is thread	and interrupt safe only	if no MPI routine that
       updates or frees	the same MPI object may	be  called  concurrently  with
       this routine.

       The MPI standard	defined	a thread-safe interface	but this does not mean
       that all	routines may be	called without any thread locks.  For example,
       two  threads  must  not	attempt	 to  change  the  contents of the same
       MPI_Info	object concurrently.  The user is responsible in this case for
       using  some  mechanism,	such  as thread	locks, to ensure that only one
       thread at a time	makes use of this routine.

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 com-
       municators),	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	prede-
       fined 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_COMM
	      -	Invalid	communicator.  A common	error is to use	a null	commu-
	      nicator in a call	(not even allowed in MPI_Comm_rank ).

LOCATION
       src/mpi/comm/comm_set_name.c

				   9/20/2012		  MPI_Comm_set_name(3)

NAME | SYNOPSIS | INPUT PARAMETERS | THREAD AND INTERRUPT SAFETY | NOTES FOR FORTRAN | ERRORS | LOCATION

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MPI_Comm_set_name&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help