NAG Library Routine Document

1Purpose

x06aff returns $1$ if called from within an active OpenMP parallel region, and $0$ otherwise.

2Specification

Fortran Interface
 Function x06aff ( )
 Integer :: x06aff
#include nagmk26.h
 Integer x06aff_ ()

3Description

x06aff, for multi-threaded implementations, returns $1$ if called from within an active OpenMP parallel region, and $0$ otherwise.
Note that the equivalent OpenMP routine omp_in_parallel() returns a logical value.
In serial implementations of the NAG Library this routine will always return $0$. See the X06 Chapter Introduction for a discussion of the behaviour of these routines when called in serial.

4References

OpenMP Specifications http://openmp.org/
Chapman B, Jost G and van der Pas R (2008) Using OpenMP Portable Shared Memory Parallel Programming The MIT Press

None.

None.

Not applicable.

8Parallelism and Performance

x06aff is not threaded in any implementation.