Manual Reference Pages  - atomic_add (3fortran)

NAME

ATOMIC_ADD(3) - [ATOMIC] Atomic ADD operation

SYNOPSIS

call atomic_add (atom, value [,stat] )

         subroutine atomic_add(atom,value,stat)

integer(atomic_int_kind) :: atom[*] integer(atomic_int_kind),intent(in) :: value integer,intent(out),intent(out) :: stat

CHARACTERISTICS

o ATOM is a scalar coarray or coindexed variable of integer type with atomic_int_kind kind.
o VALUE is a scalar of the same type as ATOM. If the kind is different, the value is converted to the kind of ATOM.
o STAT is a Scalar default-kind integer variable.

DESCRIPTION

ATOMIC_ADD(3) atomically adds the value of VAR to the variable ATOM. When STAT is present and the invocation was successful, it is assigned the value 0. If it is present and the invocation has failed, it is assigned a positive value; in particular, for a coindexed ATOM, if the remote image has stopped, it is assigned the value of iso_fortran_env’s STAT_STOPPED_IMAGE and if the remote image has failed, the value STAT_FAILED_IMAGE.

OPTIONS

o ATOM : Scalar coarray or coindexed variable of integer type with atomic_int_kind kind.
o VALUE : Scalar of the same type as ATOM. If the kind is different, the value is converted to the kind of ATOM.
o STAT : (optional) Scalar default-kind integer variable.

EXAMPLES

Sample program:

    program demo_atomic_add
    use iso_fortran_env
    implicit none
    integer(atomic_int_kind) :: atom[*]
       call atomic_add (atom[1], this_image())
    end program demo_atomic_add

STANDARD

TS 18508

SEE ALSO

ATOMIC_DEFINE(3), ATOMIC_FETCH_ADD(3), ATOMIC_AND(3), ATOMIC_OR(3), ATOMIC_XOR(3) ISO_FORTRAN_ENV(3),

fortran-lang intrinsic descriptions


Nemo Release 3.1 atomic_add (3fortran) April 28, 2024
Generated by manServer 1.08 from 62f9cdd1-9a31-4c4a-b9fa-a85a3140d96e using man macros.