source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Barrier.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.8 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Barrier 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Barrier\fP \- Blocks until all processes have reached this routine.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Barrier(MPI_Comm \fIcomm\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_BARRIER(\fICOMM\fP,\fI IERROR\fP)
18        INTEGER \fICOMM\fP,\fI IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23void MPI::Comm::Barrier() const = 0
24
25.SH INPUT PARAMETER
26.ft R
27.TP 1i
28comm
29Communicator (handle).
30
31.SH OUTPUT PARAMETER
32.ft R
33.TP 1i
34IERROR
35Fortran only: Error status (integer).
36
37.SH DESCRIPTION
38.ft R
39Blocks the caller until all group members have called it; the call returns at any process only after all group members have entered the call.
40
41.SH WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR
42.sp
43When the communicator is an inter-communicator, the barrier operation is performed across all processes in both groups.  All processes in the first group may exit the barrier when all processes in the second group have entered the barrier. 
44
45.SH ERRORS
46Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions 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.
47.sp
48Before the error value is returned, the current MPI error handler is
49called. 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. 
50
51.SH SEE ALSO
52.ft R
53MPI_Bcast
Note: See TracBrowser for help on using the repository browser.