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

FreeBSD Manual Pages

  
 
  

home | help 
MPI_Cart_create(3)		      MPI		    MPI_Cart_create(3)

NAME
       MPI_Cart_create	-  Makes a new communicator to which topology informa-
       tion has	been attached

SYNOPSIS
       int MPI_Cart_create(MPI_Comm comm_old, int ndims, MPICH2_CONST int *dims,
			   MPICH2_CONST	int *periods, int reorder, MPI_Comm *comm_cart)

INPUT PARAMETERS
       comm_old
	      -	input communicator (handle)
       ndims  -	number of dimensions of	cartesian grid (integer)
       dims   -	integer	array of size ndims specifying the number of processes
	      in each dimension
       periods
	      -	logical	array of size ndims specifying whether the grid	is pe-
	      riodic (true) or not (false) in each dimension
       reorder
	      -	ranking	may be reordered (true)	or not (false) (logical)

OUTPUT PARAMETER
       comm_cart
	      -	communicator with new cartesian	topology (handle)

ALGORITHM
       We ignore reorder info currently.

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 guarentee 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_TOPOLOGY
	      -	Invalid	topology.  Either there	is no topology associated with
	      this communicator, or it is not the correct type (e.g., MPI_CART
	      when expecting MPI_GRAPH ).
       MPI_ERR_DIMS
	      -	 Invalid  dimension argument.  A dimension argument is null or
	      its length is less than or equal to zero.
       MPI_ERR_ARG
	      -	Invalid	argument.  Some	argument is invalid and	is not identi-
	      fied by a	specific error class (e.g., MPI_ERR_RANK ).

LOCATION
       src/mpi/topo/cart_create.c

				   9/20/2012		    MPI_Cart_create(3)
NAME | SYNOPSIS | INPUT PARAMETERS | OUTPUT PARAMETER | ALGORITHM | 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_Cart_create&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help