added Verlet scheme and NxN non-bonded functionality
[alexxy/gromacs.git] / include / gmx_omp.h
index 3fe53b00a762d954f594403276241b8e433bc5cb..de55a43bf57315d75c8b386af00074c034702a5d 100644 (file)
 
 /* This module defines wrappers for OpenMP API functions and enables compiling
  * code even when OpenMP is turned off in the build system.
- * Therfore, OpenMP API functions should always be used through these wrappers
+ * Therefore, OpenMP API functions should always be used through these wrappers
  * and omp.h should never be directly included. Instead, this header should be
- * used whnever OpenMP API functions are needed.
+ * used whenever OpenMP API functions are needed.
  */
 
-/*! Sets the number of threads in subsequent parallel regions, unless overridden
- *  by a num_threads clause. Acts as a wrapper for omp_get_max_threads(void). */
+/*! Returns an integer equal to or greater than the number of threads
+ *  that would be available if a parallel region without num_threads were
+ *  defined at that point in the code. Acts as a wrapper for omp_set_num_threads(void). */
 int  gmx_omp_get_max_threads(void);
 
+/*! Returns the number of processors available when the function is called.
+ *  Acts as a wrapper around omp_get_num_procs() */
+int gmx_omp_get_num_procs(void);
+
 /*! Returns the thread number of the thread executing within its thread team.
- *  Acts as a warpper for omp_get_thread_num(void). */
+ *  Acts as a wrapper for omp_get_thread_num(void). */
 int  gmx_omp_get_thread_num(void);
 
-/*! Returns an integer that is equal to or greater than the number of threads
- * that would be available if a parallel region without num_threads were
- * defined at that point in the code. Acts as a wapepr for omp_set_num_threads(void). */
+/*! Sets the number of threads in subsequent parallel regions, unless overridden
+ *  by a num_threads clause. Acts as a wrapper for omp_get_max_threads(void). */
 void gmx_omp_set_num_threads(int num_threads);
 
 #endif /* GMX_OMP_H */