17.2.270. MPI_Op_free

MPI_Op_free - Frees a user-defined combination function handle.

17.2.270.1. SYNTAX

17.2.270.1.1. C Syntax

#include <mpi.h>

int MPI_Op_free(MPI_Op *op)

17.2.270.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_OP_FREE(OP, IERROR)
     INTEGER OP, IERROR

17.2.270.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Op_free(op, ierror)
     TYPE(MPI_Op), INTENT(INOUT) :: op
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.270.2. INPUT/OUTPUT PARAMETER

  • op: Operation (handle).

17.2.270.3. OUTPUT PARAMETER

  • IERROR: Fortran only: Error status (integer).

17.2.270.4. DESCRIPTION

Marks a user-defined reduction operation for deallocation and sets op to MPI_OP_NULL.

17.2.270.5. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

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.