src/gromacs/legacyheaders/gmx_omp_nthreads.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012,2013, 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
  36 #ifndef GMX_OMP_NTHREADS
  37 #define GMX_OMP_NTHREADS
  38
  39 #include "types/commrec.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44 #if 0
  45 }
  46 #endif
  47
  48 /*! Enum values corresponding to multithreaded algorithmic modules. */
  49 typedef enum module_nth
  50 {
  51     /* Default is meant to be used in OMP regions outside the named
  52      * algorithmic modules listed below. */
  53     emntDefault, emntDomdec, emntPairsearch, emntNonbonded,
  54     emntBonded, emntPME,  emntUpdate, emntVSITE, emntLINCS, emntSETTLE,
  55     emntNR
  56 } module_nth_t;
  57
  58 /*! Initializes the per-module thread count. It is compatible with tMPI,
  59  *  thread-safety is ensured (for the features available with tMPI).
  60  *  This function should caled only once during the initialization of mdrun. */
  61 void gmx_omp_nthreads_init(FILE *fplog, t_commrec *cr,
  62                            int nthreads_hw_avail,
  63                            int omp_nthreads_req,
  64                            int omp_nthreads_pme_req,
  65                            gmx_bool bCurrNodePMEOnly,
  66                            gmx_bool bFullOmpSupport);
  67
  68 /*! Returns the number of threads to be used in the given module m. */
  69 int gmx_omp_nthreads_get(int mod);
  70
  71 /*! \brief Sets the number of threads to be used in module. Intended
  72  *  for use in testing. */
  73 void gmx_omp_nthreads_set(int mod, int nthreads);
  74
  75 /*! Read the OMP_NUM_THREADS env. var. and check against the value set on the command line. */
  76 void gmx_omp_nthreads_read_env(int     *nthreads_omp,
  77                                gmx_bool bIsSimMaster);
  78
  79 #if 0
  80 {
  81 #endif
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif /* GMX_OMP_NTHREADS */