18.2.1. MPI_Abi_get_fortran_booleans

MPI_Abi_get_fortran_booleans — Retrieves Fortran ABI details for the provided Fortran logical of size logical_size.

18.2.1.1. SYNTAX

18.2.1.1.1. C Syntax

int MPI_Abi_get_fortran_booleans(int logical_size, void*
    logical_true, void* logical_false, int* is_set)

18.2.1.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ABI_GET_FORTRAN_BOOLEANS(LOGICAL_SIZE, LOGICAL_TRUE, LOGICAL_FALSE, IS_SET, IERROR)
    INTEGER LOGICAL_SIZE, IERROR
    LOGICAL LOGICAL_TRUE, LOGICAL_FALSE, IS_SET

18.2.1.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Abi_get_fortran_booleans(logical_size, logical_true, logical_false, is_set, ierror)
    INTEGER, INTENT(IN) :: logical_size
    LOGICAL, INTENT(OUT) :: logical_true, logical_false, is_set
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

18.2.1.2. INPUT PARAMETERS

  • logical_size: the size of Fortran logical in bytes

18.2.1.3. OUTPUT PARAMETERS

  • logical_true: the Fortran literal value TRUE

  • logical_false: the Fortran literal value FALSE

  • is_set: flag to indicate whether the logical boolean values were set previously (logical)

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

18.2.1.4. DESCRIPTION

MPI_Abi_get_fortran_booleans returns the values of TRUE and FALSE for a given Fortran logical size. is_set is set to true if these values have been previously set either by a call to MPI_Abi_set_fortran_booleans or internally by MPI.

logical_size is the size in bytes of a Fortran logical and must be a power of two; otherwise MPI_ERR_ARG is returned.

When Open MPI is built with Fortran logical support, this routine returns Open MPI’s configured Fortran .TRUE. and .FALSE. values for recognized logical sizes and sets is_set to true. For a power-of-two logical size that Open MPI cannot map to a configured Fortran logical representation, the routine returns MPI_SUCCESS and sets is_set to false.

When Open MPI is built without Fortran logical support, this routine returns values previously supplied with MPI_Abi_set_fortran_booleans, if any. If no values have been supplied for logical_size, the routine returns MPI_SUCCESS and sets is_set to false.

18.2.1.5. ERRORS

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

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL Causes the program to abort all connected MPI processes.

  • MPI_ERRORS_ABORT An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.

  • MPI_ERRORS_RETURN Returns an error code to the application.

MPI applications can also implement their own error handlers by calling:

Note that MPI does not guarantee that an MPI program can continue past an error.

See the MPI man page for a full list of MPI error codes.

See the Error Handling section of the MPI-5.0 standard for more information.

See also