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

FreeBSD Manual Pages

  
 
  

home | help
MPI_Comm_dup_with_info(3)	      MPI	     MPI_Comm_dup_with_info(3)

NAME
       MPI_Comm_dup_with_info -	 Duplicates an existing	communicator using the
       supplied	info hints

SYNOPSIS
       int MPI_Comm_dup_with_info(MPI_Comm comm, MPI_Info info,	MPI_Comm *newcomm)

INPUT PARAMETERS
       comm   -	communicator (handle)
       info   -	info object (handle)

OUTPUT PARAMETERS
       newcomm
	      -	copy of	comm (handle)

NOTES
       MPI_Comm_dup_with_info  behaves exactly as MPI_Comm_dup except that the
       info hints associated with the communicator comm	are not	duplicated  in
       newcomm.	  The  hints provided by the argument info are associated with
       the output communicator newcomm instead.

INFO HINTS
       mpi_assert_no_any_tag
	      -	boolean, default = false.  If set to true, user	promises  that
	      MPI_ANY_TAG  will	not be used with the communicator. This	poten-
	      tially allows MPICH to treat messages with different tags	 inde-
	      pendent and seek to improve performance, e.g. by employ multiple
	      network context.
       mpi_assert_no_any_source
	      -	 boolean, default = false.  If set to true, user promises that
	      MPI_ANY_SOURCE will not be used with the communicator. This  po-
	      tentially	allows MPICH to	treat messages send to different ranks
	      or  receive from different ranks independent and seek to improve
	      performance, e.g.	by employ multiple network context.
       mpi_assert_exact_length
	      -	boolean, default = false.  If set to true, user	promises  that
	      the  lengths  of	messages  received  by the process will	always
	      equal to the size	of the corresponding receive buffers.
       mpi_assert_allow_overtaking
	      -	boolean, default = false.  If set to true, user	 asserts  that
	      send  operations	are not	required to be matched at the receiver
	      in the order in which the	send operations	were performed by  the
	      sender, and receive operations are not required to be matched in
	      the order	in which they were performed by	the receivers.
       mpi_assert_strict_persistent_collective_ordering
	      -	 boolean, default = false.  If set to true, then the implemen-
	      tation may assume	that all the persistent	collective  operations
	      are  started  in	the same order across all MPI processes	in the
	      group of the communicator. It is required	that if	this assertion
	      is made on one member of the communicator	s group, then it  must
	      be  made	on  all	 members of that communicator s	group with the
	      same value.

THREAD AND INTERRUPT SAFETY
       This routine is thread-safe.  This  means  that	this  routine  may  be
       safely  used by multiple	threads	without	the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.   Typically,
       this  is	due to the use of memory allocation routines such as malloc or
       other non-MPICH runtime routines	that  are  themselves  not  interrupt-
       safe.

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_er-
       rhandler	 (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 guarantee	that an	MPI program can	continue  past
       an  error;  however, MPI	implementations	will attempt to	continue when-
       ever possible.

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.
       MPI_ERR_ARG
	      -	Invalid	argument.  Some	argument is invalid and	is not identi-
	      fied by a	specific error class (e.g., MPI_ERR_RANK ).
       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 ).
       MPI_ERR_INFO
	      -	Invalid	Info
       MPI_ERR_OTHER
	      -	 Other	error;	use  MPI_Error_string  to get more information
	      about this error code.

SEE ALSO
       MPI_Comm_dup,	MPI_Comm_free,	  MPI_Keyval_create,	 MPI_Attr_put,
       MPI_Attr_delete,	      MPI_Comm_create_keyval,	    MPI_Comm_set_attr,
       MPI_Comm_delete_attr

				   2/3/2025	     MPI_Comm_dup_with_info(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Comm_dup_with_info&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help