mpi_graph_map(3openmpi) [osx man page]

MPI_Graph_map(3OpenMPI) 												   MPI_Graph_map(3OpenMPI)

NAME

       MPI_Graph_map  - Maps process to graph topology information.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Graph_map(MPI_Comm comm, int nnodes, int *index,
	    int *edges, int *newrank)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GRAPH_MAP(COMM, NNODES, INDEX, EDGES, NEWRANK, IERROR)
	    INTEGER   COMM, NNODES, INDEX(*), EDGES(*), NEWRANK, IERROR

C++ Syntax
       #include <mpi.h>
       int Graphcomm::Map(int nnodes, const int index[],
	    const int edges[]) const

INPUT PARAMETERS

       comm	 Input communicator (handle).

       nnodes	 Number of graph nodes (integer).

       index	 Integer array specifying the graph structure, see  MPI_Graph_ create.

       edges	 Integer array specifying the graph structure.

OUTPUT PARAMETERS

       newrank	 Reordered rank of the calling process; MPI_UNDEFINED if the calling process does not belong to graph (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Cart_map  and  MPI_Graph_map  can  be  used	to  implement all other topology functions. In general they will not be called by the user
       directly, unless he or she is creating additional virtual topology capability other than that provided by MPI.

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_Cart_map

Open MPI 1.2							  September 2006					   MPI_Graph_map(3OpenMPI)

Check Out this Related Man Page

MPI_Graphdims_get(3OpenMPI)											       MPI_Graphdims_get(3OpenMPI)

NAME

       MPI_Graphdims_get  - Retrieves graph topology information associated with a communicator.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Graphdims_get(MPI_Comm comm, int *nnodes, int *nedges)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_GRAPHDIMS_GET(COMM, NNODES, NEDGES, IERROR)
	    INTEGER   COMM, NNODES, NEDGES, IERROR

C++ Syntax
       #include <mpi.h>
       void Graphcomm::Get dims(int nnodes[], int nedges[]) const

INPUT PARAMETER

       comm	 Communicator for group with graph structure (handle).

OUTPUT PARAMETERS

       nnodes	 Number of nodes in graph (integer).

       nedges	 Number of edges in graph (integer).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       Functions  MPI_Graphdims_get  and  MPI_Graph_get  retrieve  the	graph-topology	information  that  was	associated  with a communicator by
       MPI_Graph_create.

       The information provided by MPI_Graphdims_get can be used to dimension the vectors index and edges correctly for a call to MPI_Graph_get.

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_Graph_get

Open MPI 1.2							  September 2006				       MPI_Graphdims_get(3OpenMPI)

Linux and UNIX Man Pages

mpi_graph_map(3openmpi) [osx man page]

Check Out this Related Man Page