include/gmx_omp_nthreads.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2012, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef GMX_OMP_NTHREADS
  40 #define GMX_OMP_NTHREADS
  41 #include "visibility.h"
  42 #include "types/commrec.h"
  43
  44
  45 /*! Enum values corresponding to multithreaded algorithmic modules. */
  46 typedef enum module_nth
  47 {
  48     /* Default is meant to be used in OMP regions outside the named
  49      * algorithmic modules listed below. */
  50     emntDefault, emntDomdec, emntPairsearch, emntNonbonded,
  51     emntBonded, emntPME,  emntUpdate, emntVSITE, emntLINCS, emntSETTLE,
  52     emntNR
  53 } module_nth_t;
  54
  55 /*! Initializes the per-module thread count. It is compatible with tMPI,
  56  *  thread-safety is ensured (for the features available with tMPI).
  57  *  This function should caled only once during the initialization of mdrun. */
  58 GMX_LIBGMX_EXPORT
  59 void gmx_omp_nthreads_init(FILE *fplog, t_commrec *cr,
  60                            int nthreads_hw_avail,
  61                            int omp_nthreads_req,
  62                            int omp_nthreads_pme_req,
  63                            gmx_bool bCurrNodePMEOnly,
  64                            gmx_bool bFullOmpSupport);
  65
  66 /*! Returns the number of threads to be used in the given module m. */
  67 GMX_LIBGMX_EXPORT
  68 int gmx_omp_nthreads_get(int mod);
  69
  70 /*! Read the OMP_NUM_THREADS env. var. and check against the value set on the command line. */
  71 GMX_LIBGMX_EXPORT
  72 void gmx_omp_nthreads_read_env(int *nthreads_omp,
  73                                gmx_bool bIsSimMaster);
  74
  75 #endif /* GMX_OMP_NTHREADS */