FreeBSD Manual Pages
MPI_Topo_test(3) MPI MPI_Topo_test(3) NAME MPI_Topo_test - Determines the type of topology (if any) associated with a communicator SYNOPSIS int MPI_Topo_test(MPI_Comm comm, int *topo_type) INPUT PARAMETER comm - communicator (handle) OUTPUT PARAMETER top_type - topology type of communicator comm (integer). If the communi- cator has no associated topology, returns MPI_UNDEFINED . 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 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_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_ARG - Invalid argument. Some argument is invalid and is not identi- fied by a specific error class (e.g., MPI_ERR_RANK ). SEE ALSO MPI_Graph_create, MPI_Cart_create LOCATION src/mpi/topo/topo_test.c 9/20/2012 MPI_Topo_test(3)
NAME | SYNOPSIS | INPUT PARAMETER | OUTPUT PARAMETER | THREAD AND INTERRUPT SAFETY | NOTES FOR FORTRAN | ERRORS | SEE ALSO | LOCATION
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Topo_test&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>