NAG FL Interface
x06agf (set_​nested)

Note: this routine is deprecated and will be withdrawn at Mark 31.3. Replaced by x06ajf.

Old Code


New Code

x06ajf(num, ifail)
if nesting would be set to 0 then num must be 1. If nesting would be set to 1 set num to the number of nested active parallel regions required.
Settings help

FL Name Style:

FL Specification Language:

1 Purpose

x06agf enables or disables nested OpenMP parallelism.

2 Specification

Fortran Interface
Subroutine x06agf ( nesting)
Integer, Intent (In) :: nesting
C Header Interface
#include <nag.h>
void  x06agf_ (const Integer *nesting)
The routine may be called by the names x06agf or nagf_omp_set_nested.

3 Description

x06agf, for multithreaded implementations, enables or disables the nesting of OpenMP parallel regions by setting an OpenMP Internal Control Variable (ICV) and any vendor library specific options where that is possible. See the Users' Note for your implementation for details of the scope of x06agf.
Nesting is disabled by default in OpenMP.
In serial implementations of the NAG Library x06agf has no effect. See the Chapter X06 for a discussion of the behaviour of these routines 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

1: nesting Integer Input
On entry: if nesting=0, nesting of OpenMP parallel regions is disabled, otherwise it is enabled.

6 Error Indicators and Warnings


7 Accuracy

Not applicable.

8 Parallelism and Performance

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

9 Further Comments


10 Example

In this example we presume a multithreaded implementation of the NAG Library. We call x06agf to enable the nesting of OpenMP parallel regions by setting an ICV. Inside a first, or ‘outer’, parallel region we call x06ahf to display the status of nesting, and expect to see it return the value 1.
Each thread then spawns a second ‘inner’ parallel region. Within this region we have each thread increment the value total. As there are 5 threads in the outer region and 3 threads in each inner region we expect the final value of this variable to be 15.
If you use a serial implementation of the NAG Library, regardless of whether the code is compiled with OpenMP or not, x06agf will have no effect and x06ahf will always return 0. The total number of threads will be 1. The appropriate results file will be included with the distribution material for your implementation.

10.1 Program Text

Program Text (x06agfe.f90)

10.2 Program Data


10.3 Program Results

Program Results (x06agfe.r)