src/gromacs/utility/gmxomp.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares OpenMP wrappers to avoid conditional compilation.
  38  *
  39  * This module defines wrappers for OpenMP API functions and enables compiling
  40  * code without conditional compilation even when OpenMP is turned off in the
  41  * build system.
  42  * Therefore, OpenMP API functions should always be used through these wrappers
  43  * and omp.h should never be directly included.  Instead, this header should be
  44  * used whenever OpenMP API functions are needed.
  45  *
  46  * \inlibraryapi
  47  * \ingroup module_utility
  48  */
  49 #ifndef GMX_UTILITY_OMP_H
  50 #define GMX_UTILITY_OMP_H
  51
  52 #include "types/commrec.h"
  53 #include "mdrun.h"
  54
  55 #ifdef __cplusplus
  56 extern "C"
  57 {
  58 #endif
  59
  60 /*! \addtogroup module_utility
  61  * \{
  62  */
  63
  64 /*! \brief
  65  * Returns an integer equal to or greater than the number of threads
  66  * that would be available if a parallel region without num_threads were
  67  * defined at that point in the code.
  68  *
  69  * Acts as a wrapper for omp_get_max_threads().
  70  */
  71 int gmx_omp_get_max_threads(void);
  72
  73 /*! \brief
  74  * Returns the number of processors available when the function is called.
  75  *
  76  * Acts as a wrapper around omp_get_num_procs().
  77  */
  78 int gmx_omp_get_num_procs(void);
  79
  80 /*! \brief
  81  * Returns the thread number of the thread executing within its thread team.
  82  *
  83  * Acts as a wrapper for omp_get_thread_num().
  84  */
  85 int gmx_omp_get_thread_num(void);
  86
  87 /*! \brief
  88  * Sets the number of threads in subsequent parallel regions, unless overridden
  89  * by a num_threads clause.
  90  *
  91  * Acts as a wrapper for omp_set_num_threads().
  92  */
  93 void gmx_omp_set_num_threads(int num_threads);
  94
  95 /*! \brief
  96  * Check for externally set thread affinity to avoid conflicts with \Gromacs
  97  * internal setting.
  98  */
  99 void gmx_omp_check_thread_affinity(FILE *fplog, const t_commrec *cr,
 100                                    gmx_hw_opt_t *hw_opt);
 101
 102 /*! \} */
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif