GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MPIX_COMM_SPLIT_TYPE (3)

NAME

MPIX_Comm_split_type - Creates new communicators based on split types and keys

CONTENTS

Synopsis
Input Parameters
Output Parameter
Notes
Thread And Interrupt Safety
Notes For Fortran
Errors
See Also
Location

SYNOPSIS

int MPIX_Comm_split_type(MPI_Comm comm, int split_type, int key, MPI_Info info,
                         MPI_Comm * newcomm)

INPUT PARAMETERS

comm - communicator (handle)
split_type
  - type of processes to be grouped together (nonnegative integer).
key - control of rank assigment (integer)
info - hints to improve communicator creation (handle)

OUTPUT PARAMETER

newcomm
  - new communicator (handle)

NOTES

The split_type must be non-negative or MPI_UNDEFINED .

THREAD AND INTERRUPT SAFETY

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as malloc or other non-MPICH runtime routines that are themselves not interrupt-safe.

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_INTERN
  - This error is returned when some part of the MPICH implementation is unable to acquire memory.

SEE ALSO

MPI_Comm_free

LOCATION

src/mpi/comm/comm_split_type.c
Search for    or go to Top of page |  Section 3 |  Main Index


MPIX_COMM_SPLIT_TYPE (3) 9/20/2012

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.