Blame www/www3/MPI_Comm_spawn_multiple.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Comm_spawn_multiple</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Comm_spawn_multiple

Packit Service c5cf8c
short description 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Comm_spawn_multiple(int count, char *array_of_commands[],
Packit Service c5cf8c
                            char **array_of_argv[], const int array_of_maxprocs[],
Packit Service c5cf8c
                            const MPI_Info array_of_info[], int root, MPI_Comm comm,
Packit Service c5cf8c
                            MPI_Comm * intercomm, int array_of_errcodes[])
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
count
number of commands (positive integer, significant to MPI only at
Packit Service c5cf8c
root
Packit Service c5cf8c
Packit Service c5cf8c
array_of_commands
programs to be executed (array of strings, significant
Packit Service c5cf8c
only at root)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_argv
arguments for commands (array of array of strings,
Packit Service c5cf8c
significant only at root)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_maxprocs
maximum number of processes to start for each command
Packit Service c5cf8c
(array of integer, significant only at root)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_info
info objects telling the runtime system where and how to
Packit Service c5cf8c
start processes (array of handles, significant only at root)
Packit Service c5cf8c
Packit Service c5cf8c
root
rank of process in which previous arguments are examined (integer)
Packit Service c5cf8c
Packit Service c5cf8c
comm
intracommunicator containing group of spawning processes (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
intercomm
intercommunicator between original group and newly spawned group
Packit Service c5cf8c
(handle)
Packit Service c5cf8c
Packit Service c5cf8c
array_of_errcodes
one error code per process (array of integer)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

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

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

Packit Service c5cf8c

Errors

Packit Service c5cf8c

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

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_COMM
Invalid communicator. A common error is to use a null
Packit Service c5cf8c
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_ARG
Invalid argument. Some argument is invalid and is not
Packit Service c5cf8c
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_INFO
Invalid Info
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_SPAWN
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>