NAG CL Interface
x06ahc (get_​nested)

Note: this function is deprecated and will be withdrawn at Mark 31.3. Replaced by x06akc.
Settings help

CL Name Style:


1 Purpose

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

2 Specification

#include <nag.h>
Integer  x06ahc ()
The function may be called by the names: x06ahc or nag_omp_get_nested.

3 Description

x06ahc, for multithreaded implementations, tests whether the nesting of OpenMP parallel regions has been enabled as if with a call to x06agc. The return value will be 1 if nesting is enabled or 0 if it is disabled.
In serial implementations of the NAG Library x06ahc will always return 0. See the X06 Chapter Introduction for a discussion of the behaviour of these functions when called in serial.

4 References

The OpenMP API Specification for Parallel Programming
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

Background information to multithreading can be found in the Multithreading documentation.
x06ahc is not threaded in any implementation.

9 Further Comments

None.

10 Example

See x06agc for a demonstration of how to use x06ahc.