NAG Library Routine Document

x06ahf (get_nested)

1
Purpose

x06ahf returns 1 if nested OpenMP parallelism has been enabled, and 0 otherwise.

2
Specification

Fortran Interface
Function x06ahf ( )
Integer:: x06ahf
C Header Interface
#include <nagmk26.h>
Integer  x06ahf_ ()

3
Description

x06ahf, for multi-threaded implementations, tests whether the nesting of OpenMP parallel regions has been enabled as if with a call to x06agf. The return value will be 1 if nesting is enabled or 0 if it is disabled.
Note the equivalent OpenMP routine omp_get_nested() returns a logical value.
In serial implementations of the NAG Library x06ahf will always return 0. See the X06 Chapter Introduction for a discussion of the behaviour of these routines when called in serial.

4
References

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

5
Arguments

None.

6
Error Indicators and Warnings

None.

7
Accuracy

Not applicable.

8
Parallelism and Performance

x06ahf is not threaded in any implementation.

9
Further Comments

None.

10
Example

See Section 10 in x06agf for a demonstration of how to use x06ahf.