3.4.3  omp_set_num_teams

Summary The omp_set_num_teams routine affects the number of threads to be used for subsequent teams regions that do not specify a num_teams clause, by setting the value of the nteams-var ICV of the current task.

Format

 
void omp_set_num_teams(int num_teams);
  

 
subroutine omp_set_num_teams(num_teams) 
integer num_teams
  

Constraints on Arguments The value of the argument passed to this routine must evaluate to a positive integer, or else the behavior of this routine is implementation defined.

Binding The binding task set for an omp_set_num_teams region is the generating task.

Effect The effect of this routine is to set the value of the nteams-var ICV of the current task to the value specified in the argument.

Restrictions Restrictions to the omp_set_num_teams routine are as follows:

• The routine may not be called from within a parallel region that is not the implicit parallel region that surrounds the whole OpenMP program.

Cross References

• nteams-var ICV, see Section 2.4.
• teams construct and num_teams clause, see Section 2.7.
• omp_get_num_teams routine, see Section 3.4.1.
• omp_get_max_teams routine, see Section 3.4.4.
• OMP_NUM_TEAMS environment variable, see Section 6.23.