Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_topo_test(3openmpi) [osx man page]

MPI_Topo_test(3OpenMPI) 												   MPI_Topo_test(3OpenMPI)

NAME
MPI_Topo_test - Determines the type of topology (if any) associated with a communicator. SYNTAX
C Syntax #include <mpi.h> int MPI_Topo_test(MPI_Comm comm, int *top_type) Fortran Syntax INCLUDE 'mpif.h' MPI_TOPO_TEST(COMM, TOP_TYPE, IERROR) INTEGER COMM, TOP_TYPE, IERROR C++ Syntax #include <mpi.h> int Comm::Get_topology() const INPUT PARAMETER
comm Communicator (handle). OUTPUT PARAMETERS
top_type Topology type of communicator comm (choice). IERROR Fortran only: Error status (integer). DESCRIPTION
The function MPI_Topo_test returns the type of topology that is assigned to a communicator. The output value top_type is one of the following: MPI_GRAPH graph topology MPI_CART Cartesian topology MPI_UNDEFINED no topology 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_Graph_create MPI_Cart_create Open MPI 1.2 September 2006 MPI_Topo_test(3OpenMPI)

Check Out this Related Man Page

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 communicator 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 communicators), 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 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 whenever possible. MPI_SUCCESS - No error; MPI routine completed successfully. MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank ). MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK ). SEE ALSO
MPI_Graph_create, MPI_Cart_create LOCATION
topo_test.c 11/2/2007 MPI_Topo_test(3)
Man Page