naginterfaces.library.omp.get_​max_​active_​levels

naginterfaces.library.omp.get_max_active_levels()[source]

get_max_active_levels returns the maximum number of nested active parallel regions allowed.

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

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

Returns
nlint

The returned maximum number of active nested parallel regions allowed.

Notes

get_max_active_levels, for multithreaded implementations, retrieves the maximum number of nested active parallel regions allowed. This has either been set by the user or is the default for the implementation of OpenMP being used.

In serial implementations of the NAG Library this function will always return . 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