Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_comm_create(3openmpi) [osx man page]

MPI_Comm_create(3OpenMPI)												 MPI_Comm_create(3OpenMPI)

NAME
MPI_Comm_create - Creates a new communicator. SYNTAX
C Syntax #include <mpi.h> int MPI_Comm_create(MPI_Comm comm, MPI_Group group, MPI_Comm *newcomm) Fortran Syntax INCLUDE 'mpif.h' MPI_COMM_CREATE(COMM, GROUP, NEWCOMM, IERROR) INTEGER COMM, GROUP, NEW, IERROR C++ Syntax #include <mpi.h> MPI::Intercomm MPI::Intercomm::Create(const Group& group) const MPI::Intracomm MPI::Intracomm::Create(const Group& group) const INPUT PARAMETER
comm Communicator (handle). group Group, which is a subset of the group of comm (handle). OUTPUT PARAMETERS
newcomm New communicator (handle). IERROR Fortran only: Error status (integer). DESCRIPTION
This function creates a new communicator newcomm with communication group defined by group and a new context. The function sets newcomm to a new communicator that spans all the processes that are in the group. It sets newcomm to MPI_COMM_NULL for processes that are not in the group. The call is erroneous if not all group arguments have the same value, or if group is not a subset of the group associated with comm. Note that the call must be executed by all processes in comm, even if they do not belong to the new group. NOTES
MPI_Comm_create provides a means of making a subset of processes for the purpose of separate MIMD computation, with separate communication space. newcomm, which is created by MPI_Comm_create, can be used in subsequent calls to MPI_Comm_create (or other communicator construc- tors) to further subdivide a computation into parallel sub-computations. A more general service is provided by MPI_Comm_split. 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_Comm_split MPI_Intercomm_create Open MPI 1.2 September 2006 MPI_Comm_create(3OpenMPI)

Check Out this Related Man Page

MPI_Comm_accept(3OpenMPI)												 MPI_Comm_accept(3OpenMPI)

NAME
MPI_Comm_accept - Establishes communication with a client. SYNTAX
C Syntax #include <mpi.h> int MPI_Comm_accept(char *port_name, MPI_Info info, int root, MPI_Comm comm, MPI_Comm *newcomm) Fortran Syntax INCLUDE 'mpif.h' MPI_COMM_ACCEPT(PORT_NAME, INFO, ROOT, COMM, NEWCOMM, IERROR) CHARACTER*(*) PORT_NAME INTEGER INFO, ROOT, COMM, NEWCOMM, IERROR C++ Syntax #include <mpi.h> MPI::Intercomm MPI::Intracomm::Accept(const char* port_name, const MPI::Info& info, int root) const INPUT PARAMETERS
port_name Port name (string, used only on root). info Options given by root for the accept (handle, used only on root). No options currently supported. root Rank in comm of root node (integer). comm Intracommunicator over which call is collective (handle). OUTPUT PARAMETERS
newcomm Intercommunicator with client as remote group (handle) IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Comm_accept establishes communication with a client. It is collective over the calling communicator. It returns an intercommunicator that allows communication with the client, after the client has connected with the MPI_Comm_accept function using the MPI_Comm_connect function. The port_name must have been established through a call to MPI_Open_port on the root. 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. See the MPI man page for a full list of MPI error codes. SEE ALSO
MPI_Comm_connect MPI_Open_port Open MPI 1.2 March 2007 MPI_Comm_accept(3OpenMPI)
Man Page