naginterfaces.library.omp.get_​nested

naginterfaces.library.omp.get_nested()

get_nested returns $True$ if nested OpenMP parallelism has been enabled, and $False$ otherwise.

Deprecated since version 28.3.0.0: get_nested will be removed in naginterfaces 31.3.0.0. Please use get_max_active_levels() instead. See also the Replacement Calls document.

For full information please refer to the NAG Library document for x06ah

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x06/x06ahf.html

Returns

nestingbool

$True$ if nested OpenMP parallelism has been enabled, and $False$ otherwise.

Notes

get_nested, for multithreaded implementations, tests whether the nesting of OpenMP parallel regions has been enabled as if with a call to set_nested(). The return value will be $True$ if nesting is enabled or $False$ if it is disabled.

In serial implementations of the NAG Library get_nested will always return $False$. See the X06 Introduction for a discussion of the behaviour of these functions when called in serial.

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