Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 1.57 KB

MPI_Abort.3.rst

File metadata and controls

77 lines (49 loc) · 1.57 KB
Raw

MPI_Abort

:ref:`MPI_Abort` - Terminates MPI execution environment.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Abort(MPI_Comm comm, int errorcode)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ABORT(COMM, ERRORCODE, IERROR)
     INTEGER         COMM, ERRORCODE, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Abort(comm, errorcode, ierror)
     TYPE(MPI_Comm), INTENT(IN) :: comm
     INTEGER, INTENT(IN) :: errorcode
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • comm: Communicator of tasks to abort.
  • errorcode: Error code to return to invoking environment.

OUTPUT PARAMETER

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

DESCRIPTION

This routine makes a "best attempt" to abort all tasks in the group of comm. This function does not require that the invoking environment take any action with the error code. However, a UNIX or POSIX environment should handle this as a return errorcode from the main program or an abort (errorcode).

The long-term goal of the Open MPI implementation is to terminate all processes in all tasks that contain a process in comm, and the error code is not returned to the invoking environment. At the moment, this isn't fully implemented and :ref:`MPI_Abort` will terminate the entire job.

Note: All associated processes are sent a SIGTERM.

ERRORS