mpi_group_size.3

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

.\"Copyright 2006, Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.TH MPI_Group_size 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Group_size\fP \- Returns the size of a group.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Group_size(MPI_Group \fIgroup\fP, int \fI*size\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
MPI_GROUP_SIZE(\fIGROUP, SIZE, IERROR\fP)
	INTEGER	\fIGROUP, SIZE, IERROR\fP

.SH C++ Syntax
.nf
#include <mpi.h>
int Group::Get_size() const

.SH INPUT PARAMETERS
.ft R
.TP 1i
group
Group (handle).

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
size
Number of processes in the group (integer).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_Group_size returns in \fIsize\fP the number of processes in the group. Thus, if group = MPI_GROUP_EMPTY, then the call will return size = 0. On the other hand, a call with group = MPI_GROUP_NULL is erroneous.

.SH 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++ 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.
.sp
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.  

' @(#)MPI_Group_size.3 1.20 06/03/09