2 * This file is part of the GROMACS molecular simulation package.
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.
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.
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.
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.
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.
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.
36 #ifndef GMX_OMP_NTHREADS_H
37 #define GMX_OMP_NTHREADS_H
41 #include "../utility/basedefinitions.h"
52 /** Enum values corresponding to multithreaded algorithmic modules. */
53 typedef enum module_nth
55 /* Default is meant to be used in OMP regions outside the named
56 * algorithmic modules listed below. */
57 emntDefault, emntDomdec, emntPairsearch, emntNonbonded,
58 emntBonded, emntPME, emntUpdate, emntVSITE, emntLINCS, emntSETTLE,
63 * Initializes the per-module thread count.
65 * It is compatible with tMPI, thread-safety is ensured (for the features
66 * available with tMPI).
67 * This function should caled only once during the initialization of mdrun. */
68 void gmx_omp_nthreads_init(FILE *fplog, struct t_commrec *cr,
69 int nthreads_hw_avail,
71 int omp_nthreads_pme_req,
72 gmx_bool bCurrNodePMEOnly,
73 gmx_bool bFullOmpSupport);
76 * Returns the number of threads to be used in the given module \p mod. */
77 int gmx_omp_nthreads_get(int mod);
79 /*! \brief Sets the number of threads to be used in module.
81 * Intended for use in testing. */
82 void gmx_omp_nthreads_set(int mod, int nthreads);
85 * Read the OMP_NUM_THREADS env. var. and check against the value set on the
87 void gmx_omp_nthreads_read_env(int *nthreads_omp,
88 gmx_bool bIsSimMaster);