opm-simulators
threadmanager.hpp
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
27 #ifndef OPM_THREAD_MANAGER_HPP
28 #define OPM_THREAD_MANAGER_HPP
29 
30 namespace Opm {
31 
36 {
37 public:
38  enum {
39 #if defined(_OPENMP) || DOXYGEN
40  isFake = false
42 #else
43  isFake = true
44 #endif
45  };
46 
50  static void registerParameters();
51 
61  static void init(bool queryCommandLineParameter = true);
62 
66  static unsigned maxThreads()
67  { return static_cast<unsigned>(numThreads_); }
68 
72  static unsigned threadId();
73 
74 private:
75  static int numThreads_;
76 };
77 
78 } // namespace Opm
79 
80 #endif // OPM_THREAD_MANAGER_HPP
Simplifies multi-threaded capabilities.
Definition: threadmanager.hpp:35
static unsigned maxThreads()
Return the maximum number of threads of the current process.
Definition: threadmanager.hpp:66
static void init(bool queryCommandLineParameter=true)
Initialize number of threads used thread manager.
Definition: threadmanager.cpp:44
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
static void registerParameters()
Register all run-time parameters of the thread manager.
Definition: threadmanager.cpp:37
static unsigned threadId()
Return the index of the current OpenMP thread.
Definition: threadmanager.cpp:84