Blame www/www3/MPI_Graph_map.html

Packit 0848f5
Packit 0848f5
<HTML>
Packit 0848f5
<HEAD>
Packit 0848f5
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit 0848f5
<TITLE>MPI_Graph_map</TITLE>
Packit 0848f5
</HEAD>
Packit 0848f5
<BODY BGCOLOR="FFFFFF">
Packit 0848f5

MPI_Graph_map

Packit 0848f5
Maps process to graph topology information 
Packit 0848f5

Synopsis

Packit 0848f5
Packit 0848f5
int MPI_Graph_map(MPI_Comm comm, int nnodes, const int indx[], const int edges[],
Packit 0848f5
                  int *newrank)
Packit 0848f5
Packit 0848f5

Input Parameters

Packit 0848f5
Packit 0848f5
comm
input communicator (handle)
Packit 0848f5
Packit 0848f5
nnodes
number of graph nodes (integer)
Packit 0848f5
Packit 0848f5
indx
integer array specifying the graph structure, see <tt>MPI_GRAPH_CREATE</tt>
Packit 0848f5
Packit 0848f5
edges
integer array specifying the graph structure
Packit 0848f5
Packit 0848f5

Packit 0848f5

Output Parameters

Packit 0848f5
newrank
reordered rank of the calling process; <tt>MPI_UNDEFINED</tt> if the
Packit 0848f5
calling process does not belong to graph (integer) 
Packit 0848f5
Packit 0848f5

Packit 0848f5

Thread and Interrupt Safety

Packit 0848f5

Packit 0848f5
This routine is both thread- and interrupt-safe.
Packit 0848f5
This means that this routine may safely be used by multiple threads and
Packit 0848f5
from within a signal handler.
Packit 0848f5

Packit 0848f5

Notes for Fortran

Packit 0848f5
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit 0848f5
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit 0848f5
</tt>is an integer and has the same meaning as the return value of the routine
Packit 0848f5
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit 0848f5
<tt>call</tt> statement.
Packit 0848f5

Packit 0848f5
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit 0848f5
</tt>in Fortran.
Packit 0848f5

Packit 0848f5

Errors

Packit 0848f5

Packit 0848f5
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit 0848f5
C routines as the value of the function and Fortran routines in the last
Packit 0848f5
argument.  Before the value is returned, the current MPI error handler is
Packit 0848f5
called.  By default, this error handler aborts the MPI job.  The error handler
Packit 0848f5
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit 0848f5
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit 0848f5
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit 0848f5
its use is deprecated.  The predefined error handler
Packit 0848f5
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit 0848f5
Note that MPI does not guarentee that an MPI program can continue past
Packit 0848f5
an error; however, MPI implementations will attempt to continue whenever
Packit 0848f5
possible.
Packit 0848f5

Packit 0848f5
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit 0848f5
Packit 0848f5
MPI_ERR_TOPOLOGY
Invalid topology. Either there is no topology
Packit 0848f5
associated with this communicator, or it is not the correct type (e.g.,
Packit 0848f5
<tt>MPI_CART</tt> when expecting <tt>MPI_GRAPH</tt>).
Packit 0848f5
Packit 0848f5
MPI_ERR_COMM
Invalid communicator. A common error is to use a null
Packit 0848f5
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
Packit 0848f5
Packit 0848f5
MPI_ERR_ARG
Invalid argument. Some argument is invalid and is not
Packit 0848f5
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
Packit 0848f5
Packit 0848f5
</BODY></HTML>