libgomp/doc/openmp-runtime-library-routines/ompsetnested.rst

   1 ..
   2   Copyright 1988-2022 Free Software Foundation, Inc.
   3   This is part of the GCC manual.
   4   For copying conditions, see the copyright.rst file.
   5
   6 .. _omp_set_nested:
   7
   8 omp_set_nested -- Enable/disable nested parallel regions
   9 ********************************************************
  10
  11 Description:
  12   Enable or disable nested parallel regions, i.e., whether team members
  13   are allowed to create new teams.  The function takes the language-specific
  14   equivalent of ``true`` and ``false``, where ``true`` enables
  15   dynamic adjustment of team sizes and ``false`` disables it.
  16
  17   Enabling nested parallel regions will also set the maximum number of
  18   active nested regions to the maximum supported.  Disabling nested parallel
  19   regions will set the maximum number of active nested regions to one.
  20
  21 C/C++:
  22   .. list-table::
  23
  24      * - *Prototype*:
  25        - ``void omp_set_nested(int nested);``
  26
  27 Fortran:
  28   .. list-table::
  29
  30      * - *Interface*:
  31        - ``subroutine omp_set_nested(nested)``
  32      * -
  33        - ``logical, intent(in) :: nested``
  34
  35 See also:
  36   :ref:`omp_get_nested`, :ref:`omp_set_max_active_levels`,
  37   :ref:`OMP_MAX_ACTIVE_LEVELS`, :ref:`OMP_NESTED`
  38
  39 Reference:
  40   :openmp:`4.5`, Section 3.2.10.