Simbody  3.6
Parallel2DExecutor.h
Go to the documentation of this file.
1 #ifndef SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_H_
2 #define SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_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) 2008-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 Parallel2DExecutor;
33 class Parallel2DExecutorImpl;
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 Parallel2DExecutor class but should not be defined any other time.
37 #ifndef SimTK_SIMTKCOMMON_DEFINING_PARALLEL_2D_EXECUTOR
38  extern template class PIMPLHandle<Parallel2DExecutor, Parallel2DExecutorImpl>;
39 #endif
40 
74 public:
75  class Task;
76  enum RangeType {FullMatrix, HalfMatrix, HalfPlusDiagonal};
84  explicit Parallel2DExecutor(int gridSize, int numThreads = ParallelExecutor::getNumProcessors());
94  Parallel2DExecutor(int gridSize, ParallelExecutor& executor);
103  void execute(Task& task, RangeType rangeType);
107  ParallelExecutor& getExecutor();
108 };
109 
115 public:
116  virtual ~Task() {
117  }
122  virtual void execute(int i, int j) = 0;
127  virtual void initialize() {
128  }
134  virtual void finish() {
135  }
136 };
137 
138 } // namespace SimTK
139 
140 #endif // SimTK_SimTKCOMMON_PARALLEL_2D_EXECUTOR_H_
PrivateImplementation.h
SimTK::Parallel2DExecutor
This class is used for performing multithreaded computations over two dimensional ranges.
Definition: Parallel2DExecutor.h:73
SimTK::ParallelExecutor::getNumProcessors
static int getNumProcessors()
Get the total number of available processor cores (physical cores and hyperthreads on Intel architect...
SimTK
This is a System that represents the dynamics of a particle moving along a smooth surface.
Definition: Assembler.h:37
SimTK::Parallel2DExecutor::Task::initialize
virtual void initialize()
This method is invoked once by each worker thread before the task is executed.
Definition: Parallel2DExecutor.h:127
SimTK_SimTKCOMMON_EXPORT
#define SimTK_SimTKCOMMON_EXPORT
Definition: SimTKcommon/include/SimTKcommon/internal/common.h:224
ParallelExecutor.h
SimTK::Parallel2DExecutor::Task::~Task
virtual ~Task()
Definition: Parallel2DExecutor.h:116
SimTK::Parallel2DExecutor::RangeType
RangeType
Definition: Parallel2DExecutor.h:76
SimTK::PIMPLHandle< Parallel2DExecutor, Parallel2DExecutorImpl >
SimTK::Parallel2DExecutor::Task::finish
virtual void finish()
This method is invoked once by each worker thread after all invocations of the task on that thread ar...
Definition: Parallel2DExecutor.h:134
SimTK::ParallelExecutor
This class is used for performing multithreaded computations.
Definition: ParallelExecutor.h:97
SimTK::Parallel2DExecutor::Task
Concrete subclasses of this abstract class represent tasks that can be executed by a Parallel2DExecut...
Definition: Parallel2DExecutor.h:114