include/gmx_omp.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /* -*- mode: c; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; c-file-style: "stroustrup"; -*-
  36  *
  37  *
  38  *                This source code is part of
  39  *
  40  *                 G   R   O   M   A   C   S
  41  *
  42  *          GROningen MAchine for Chemical Simulations
  43  *
  44  * Written by the Gromacs development team under coordination of
  45  * David van der Spoel, Berk Hess, and Erik Lindahl.
  46  *
  47  * This library is free software; you can redistribute it and/or
  48  * modify it under the terms of the GNU Lesser General Public License
  49  * as published by the Free Software Foundation; either version 2
  50  * of the License, or (at your option) any later version.
  51  *
  52  * To help us fund GROMACS development, we humbly ask that you cite
  53  * the research papers on the package. Check out http://www.gromacs.org
  54  *
  55  * And Hey:
  56  * GROup of MAchos and Cynical Suckers
  57  */
  58
  59 #ifndef GMX_OMP_H
  60 #define GMX_OMP_H
  61 #include "visibility.h"
  62 #include "types/commrec.h"
  63 #include "mdrun.h"
  64
  65 /* This module defines wrappers for OpenMP API functions and enables compiling
  66  * code even when OpenMP is turned off in the build system.
  67  * Therefore, OpenMP API functions should always be used through these wrappers
  68  * and omp.h should never be directly included. Instead, this header should be
  69  * used whenever OpenMP API functions are needed.
  70  */
  71
  72 /*! Returns an integer equal to or greater than the number of threads
  73  *  that would be available if a parallel region without num_threads were
  74  *  defined at that point in the code. Acts as a wrapper for omp_set_num_threads(void). */
  75 GMX_LIBGMX_EXPORT
  76 int  gmx_omp_get_max_threads(void);
  77
  78 /*! Returns the number of processors available when the function is called.
  79  *  Acts as a wrapper around omp_get_num_procs() */
  80 int gmx_omp_get_num_procs(void);
  81
  82 /*! Returns the thread number of the thread executing within its thread team.
  83  *  Acts as a wrapper for omp_get_thread_num(void). */
  84 GMX_LIBGMX_EXPORT
  85 int  gmx_omp_get_thread_num(void);
  86
  87 /*! Sets the number of threads in subsequent parallel regions, unless overridden
  88  *  by a num_threads clause. Acts as a wrapper for omp_get_max_threads(void). */
  89 GMX_LIBGMX_EXPORT
  90 void gmx_omp_set_num_threads(int num_threads);
  91
  92 /*! Check for externally set thread affinity to avoid conflicts with GROMACS internal setting. */
  93 GMX_LIBGMX_EXPORT
  94 void gmx_omp_check_thread_affinity(FILE *fplog, const t_commrec *cr,
  95                                    gmx_hw_opt_t *hw_opt);
  96
  97 #endif /* GMX_OMP_H */