Simbody  3.8
ParallelWorkQueue.h
Go to the documentation of this file.
1 #ifndef SimTK_SimTKCOMMON_PARALLEL_WORK_QUEUE_H_
2 #define SimTK_SimTKCOMMON_PARALLEL_WORK_QUEUE_H_
3 
4 /* -------------------------------------------------------------------------- *
5  * Simbody(tm): SimTKcommon *
6  * -------------------------------------------------------------------------- *
7  * This is part of the SimTK biosimulation toolkit originating from *
8  * Simbios, the NIH National Center for Physics-Based Simulation of *
9  * Biological Structures at Stanford, funded under the NIH Roadmap for *
10  * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody. *
11  * *
12  * Portions copyright (c) 2010-12 Stanford University and the Authors. *
13  * Authors: Peter Eastman *
14  * Contributors: *
15  * *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may *
17  * not use this file except in compliance with the License. You may obtain a *
18  * copy of the License at http://www.apache.org/licenses/LICENSE-2.0. *
19  * *
20  * Unless required by applicable law or agreed to in writing, software *
21  * distributed under the License is distributed on an "AS IS" BASIS, *
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
23  * See the License for the specific language governing permissions and *
24  * limitations under the License. *
25  * -------------------------------------------------------------------------- */
26 
27 #include "ParallelExecutor.h"
28 #include "PrivateImplementation.h"
29 
30 namespace SimTK {
31 
32 class ParallelWorkQueue;
33 class ParallelWorkQueueImpl;
34 
35 // We only want the template instantiation to occur once. This symbol is defined in the SimTK core
36 // compilation unit that defines the ParallelWorkQueue class but should not be defined any other time.
37 #ifndef SimTK_SIMTKCOMMON_DEFINING_PARALLEL_WORK_QUEUE
38  extern template class PIMPLHandle<ParallelWorkQueue, ParallelWorkQueueImpl>;
39 #endif
40 
67 public:
68  class Task;
75  explicit ParallelWorkQueue(int queueSize, int numThreads = ParallelExecutor::getNumProcessors());
83  void addTask(Task* task);
87  void flush();
88 };
89 
95 public:
96  virtual ~Task() {
97  }
102  virtual void execute() = 0;
103 };
104 
105 } // namespace SimTK
106 
107 #endif // SimTK_SimTKCOMMON_PARALLEL_WORK_QUEUE_H_
This header provides declarations of the user-visible portion of the PIMPLHandle template classes tha...
#define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:224
static int getNumProcessors()
Get the total number of available processor cores (physical cores and hyperthreads on Intel architect...
Concrete subclasses of this abstract class represent tasks that can be executed by a ParallelWorkQueu...
Definition: ParallelWorkQueue.h:94
virtual void execute()=0
This method defines the task to be performed.
virtual ~Task()
Definition: ParallelWorkQueue.h:96
This class is used for performing multithreaded computations. It maintains a queue of tasks to be exe...
Definition: ParallelWorkQueue.h:66
ParallelWorkQueue(int queueSize, int numThreads=ParallelExecutor::getNumProcessors())
Construct a ParallelWorkQueue.
void flush()
Block until all Tasks that have been added to the queue finish executing.
void addTask(Task *task)
Add a Task to the queue.
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37