Openmp.cc File Reference

#include "Openmp.hh"
#include "corecel/Assert.hh"

Functions
size_type	celeritas::openmp_thread_limit ()
	Get the maximum number of OpenMP threads that could ever execute in parallel.
size_type	celeritas::openmp_max_threads ()
	Get the maximum number of OpenMP threads that can execute in parallel.
void	celeritas::openmp_num_threads (size_type num_threads)
	Set the default number of threads for default future parallel regions.
char const *	celeritas::openmp_proc_bind ()
	Get the openmp process bind affinity for parallel regions.

Function Documentation

openmp_max_threads()

size_type celeritas::openmp_max_threads

(

)

Get the maximum number of OpenMP threads that can execute in parallel.

This value generally mirrors the OMP_NUM_THREADS environment variable.

See https://www.openmp.org/spec-html/5.0/openmpsu112.html .

openmp_num_threads()

void celeritas::openmp_num_threads

(

size_type

num_threads

)

Set the default number of threads for default future parallel regions.

See https://www.openmp.org/spec-html/5.0/openmpsu110.html .

Note

This is named in sync with the OpenMP spec, but it sets "max threads" (which is used outside a parallel region).

openmp_proc_bind()

char const * celeritas::openmp_proc_bind

(

)

Get the openmp process bind affinity for parallel regions.

See https://www.openmp.org/spec-html/5.0/openmpsu132.html .

openmp_thread_limit()

size_type celeritas::openmp_thread_limit

(

)

Get the maximum number of OpenMP threads that could ever execute in parallel.

This value generally mirrors the OMP_THREAD_LIMIT environment variable. but also may be uselessly large (i.e., INT_MAX).

See https://www.openmp.org/spec-html/5.0/openmpsu123.html .