omp_get_supported_threads_dim (GNU libgomp)

#### 3.4.8 `omp_get_supported_threads_dim` – Get upper limit of threads in a dimension ¶

Description:

  The routine returns an upper bound for the number of threads supported in dimension dim on device device_num. If dim specifies a number that exceeds the number of supported active spatial dimensions for threads, the routine returns one.

  Note: The actually supported number of threads by dimension might be lower, depending on used number of threads in other dimensions, the number of teams, and other parameters like the register use of the code to be executed.

  The effect when the routine is invoked from within a `target` region is unspecified.

  Fortran note: In GCC, this routine does not support passing default-kind integer arguments with `-fdefault-integer-8`.

C/C++:

  Prototype: | `int omp_get_supported_threads_dim(int device_num, int dim)`

Fortran:

  Interface: | `integer function omp_get_supported_threads_dim(device_num, dim)`
  | `integer :: device_num, dim`

See also:

  `omp_get_supported_active_league_dims` – Number of supported thread dimensions, `omp_get_thread_limit_dim` – Maximum number of threads in a dimension, `omp_get_max_threads` – Maximum number of threads of parallel region, `omp_get_num_teams_dim` – Number of teams along a dimension, `OMP_THREAD_LIMIT` – Set the maximum number of threads

Reference:

  OpenMP Technical Report 15, Section 29.8