"vscode:/vscode.git/clone" did not exist on "0ac3fa19672b0720380070d6ac771f2e27f290a1"
OpenCLKernels.h 62.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
#ifndef OPENMM_OPENCLKERNELS_H_
#define OPENMM_OPENCLKERNELS_H_

/* -------------------------------------------------------------------------- *
 *                                   OpenMM                                   *
 * -------------------------------------------------------------------------- *
 * This is part of the OpenMM molecular simulation toolkit originating from   *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org.               *
 *                                                                            *
12
 * Portions copyright (c) 2008-2015 Stanford University and the Authors.      *
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * This program is free software: you can redistribute it and/or modify       *
 * it under the terms of the GNU Lesser General Public License as published   *
 * by the Free Software Foundation, either version 3 of the License, or       *
 * (at your option) any later version.                                        *
 *                                                                            *
 * This program is distributed in the hope that it will be useful,            *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
 * GNU Lesser General Public License for more details.                        *
 *                                                                            *
 * You should have received a copy of the GNU Lesser General Public License   *
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.      *
 * -------------------------------------------------------------------------- */

#include "OpenCLPlatform.h"
31
32
#include "OpenCLArray.h"
#include "OpenCLContext.h"
33
#include "OpenCLFFT3D.h"
34
#include "OpenCLParameterSet.h"
35
#include "OpenCLSort.h"
36
#include "openmm/kernels.h"
37
38
39
#include "openmm/internal/CompiledExpressionSet.h"
#include "openmm/internal/CustomIntegratorUtilities.h"
#include "lepton/CompiledExpression.h"
40
41
42
43
#include "openmm/System.h"

namespace OpenMM {

44
/**
45
46
47
 * This kernel is invoked at the beginning and end of force and energy computations.  It gives the
 * Platform a chance to clear buffers and do other initialization at the beginning, and to do any
 * necessary work at the end to determine the final results.
48
 */
49
class OpenCLCalcForcesAndEnergyKernel : public CalcForcesAndEnergyKernel {
50
public:
51
    OpenCLCalcForcesAndEnergyKernel(std::string name, const Platform& platform, OpenCLContext& cl) : CalcForcesAndEnergyKernel(name, platform), cl(cl) {
52
53
54
55
56
57
58
59
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
60
     * This is called at the beginning of each force/energy computation, before calcForcesAndEnergy() has been called on
61
     * any ForceImpl.
62
     *
63
64
65
     * @param context       the context in which to execute this kernel
     * @param includeForce  true if forces should be computed
     * @param includeEnergy true if potential energy should be computed
66
     * @param groups        a set of bit flags for which force groups to include
67
     */
68
    void beginComputation(ContextImpl& context, bool includeForce, bool includeEnergy, int groups);
69
    /**
70
     * This is called at the end of each force/energy computation, after calcForcesAndEnergy() has been called on
71
72
     * every ForceImpl.
     *
73
74
75
     * @param context       the context in which to execute this kernel
     * @param includeForce  true if forces should be computed
     * @param includeEnergy true if potential energy should be computed
76
     * @param groups        a set of bit flags for which force groups to include
77
78
     * @param valid         the method may set this to false to indicate the results are invalid and the force/energy
     *                      calculation should be repeated
79
     * @return the potential energy of the system.  This value is added to all values returned by ForceImpls'
80
     * calcForcesAndEnergy() methods.  That is, each force kernel may <i>either</i> return its contribution to the
81
82
     * energy directly, <i>or</i> add it to an internal buffer so that it will be included here.
     */
83
    double finishComputation(ContextImpl& context, bool includeForce, bool includeEnergy, int groups, bool& valid);
84
private:
85
   OpenCLContext& cl;
86
87
88
};

/**
89
90
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
91
 */
92
class OpenCLUpdateStateDataKernel : public UpdateStateDataKernel {
93
public:
94
    OpenCLUpdateStateDataKernel(std::string name, const Platform& platform, OpenCLContext& cl) : UpdateStateDataKernel(name, platform), cl(cl) {
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
     * Get the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
    double getTime(const ContextImpl& context) const;
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
    void setTime(ContextImpl& context, double time);
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    /**
     * Get the positions of all particles.
     *
     * @param positions  on exit, this contains the particle positions
     */
    void getPositions(ContextImpl& context, std::vector<Vec3>& positions);
    /**
     * Set the positions of all particles.
     *
     * @param positions  a vector containg the particle positions
     */
    void setPositions(ContextImpl& context, const std::vector<Vec3>& positions);
    /**
     * Get the velocities of all particles.
     *
     * @param velocities  on exit, this contains the particle velocities
     */
    void getVelocities(ContextImpl& context, std::vector<Vec3>& velocities);
    /**
     * Set the velocities of all particles.
     *
     * @param velocities  a vector containg the particle velocities
     */
    void setVelocities(ContextImpl& context, const std::vector<Vec3>& velocities);
    /**
     * Get the current forces on all particles.
     *
     * @param forces  on exit, this contains the forces
     */
    void getForces(ContextImpl& context, std::vector<Vec3>& forces);
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    /**
     * Get the current periodic box vectors.
     *
     * @param a      on exit, this contains the vector defining the first edge of the periodic box
     * @param b      on exit, this contains the vector defining the second edge of the periodic box
     * @param c      on exit, this contains the vector defining the third edge of the periodic box
     */
    void getPeriodicBoxVectors(ContextImpl& context, Vec3& a, Vec3& b, Vec3& c) const;
    /**
     * Set the current periodic box vectors.
     *
     * @param a      the vector defining the first edge of the periodic box
     * @param b      the vector defining the second edge of the periodic box
     * @param c      the vector defining the third edge of the periodic box
     */
    void setPeriodicBoxVectors(ContextImpl& context, const Vec3& a, const Vec3& b, const Vec3& c) const;
Peter Eastman's avatar
Peter Eastman committed
160
161
162
163
164
165
166
167
168
169
170
171
    /**
     * Create a checkpoint recording the current state of the Context.
     * 
     * @param stream    an output stream the checkpoint data should be written to
     */
    void createCheckpoint(ContextImpl& context, std::ostream& stream);
    /**
     * Load a checkpoint that was written by createCheckpoint().
     * 
     * @param stream    an input stream the checkpoint data should be read from
     */
    void loadCheckpoint(ContextImpl& context, std::istream& stream);
172
private:
173
    OpenCLContext& cl;
174
};
175

176
177
178
179
180
/**
 * This kernel modifies the positions of particles to enforce distance constraints.
 */
class OpenCLApplyConstraintsKernel : public ApplyConstraintsKernel {
public:
181
182
    OpenCLApplyConstraintsKernel(std::string name, const Platform& platform, OpenCLContext& cl) : ApplyConstraintsKernel(name, platform),
            cl(cl), hasInitializedKernel(false) {
183
184
185
186
187
188
189
190
191
192
193
194
195
196
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
     * Update particle positions to enforce constraints.
     *
     * @param context    the context in which to execute this kernel
     * @param tol        the distance tolerance within which constraints must be satisfied.
     */
    void apply(ContextImpl& context, double tol);
197
198
199
200
201
202
203
    /**
     * Update particle velocities to enforce constraints.
     *
     * @param context    the context in which to execute this kernel
     * @param tol        the velocity tolerance within which constraints must be satisfied.
     */
    void applyToVelocities(ContextImpl& context, double tol);
204
205
private:
    OpenCLContext& cl;
206
207
    bool hasInitializedKernel;
    cl::Kernel applyDeltasKernel;
208
209
};

210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/**
 * This kernel recomputes the positions of virtual sites.
 */
class OpenCLVirtualSitesKernel : public VirtualSitesKernel {
public:
    OpenCLVirtualSitesKernel(std::string name, const Platform& platform, OpenCLContext& cl) : VirtualSitesKernel(name, platform), cl(cl) {
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
     * Compute the virtual site locations.
     *
     * @param context    the context in which to execute this kernel
     */
    void computePositions(ContextImpl& context);
private:
    OpenCLContext& cl;
};

233
234
235
236
237
/**
 * This kernel is invoked by HarmonicBondForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcHarmonicBondForceKernel : public CalcHarmonicBondForceKernel {
public:
238
    OpenCLCalcHarmonicBondForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcHarmonicBondForceKernel(name, platform),
Peter Eastman's avatar
Peter Eastman committed
239
            hasInitializedKernel(false), cl(cl), system(system), params(NULL) {
240
241
242
243
244
245
246
247
248
249
    }
    ~OpenCLCalcHarmonicBondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the HarmonicBondForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicBondForce& force);
    /**
250
     * Execute the kernel to calculate the forces and/or energy.
251
     *
252
253
254
255
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
256
     */
257
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
258
259
260
261
262
263
264
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the HarmonicBondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const HarmonicBondForce& force);
265
266
private:
    int numBonds;
267
    bool hasInitializedKernel;
268
    OpenCLContext& cl;
269
    const System& system;
270
    OpenCLArray* params;
271
272
};

273
274
275
276
277
/**
 * This kernel is invoked by CustomBondForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcCustomBondForceKernel : public CalcCustomBondForceKernel {
public:
278
    OpenCLCalcCustomBondForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomBondForceKernel(name, platform),
279
            hasInitializedKernel(false), cl(cl), system(system), params(NULL), globals(NULL) {
280
281
282
283
284
285
286
287
288
289
    }
    ~OpenCLCalcCustomBondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomBondForce this kernel will be used for
     */
    void initialize(const System& system, const CustomBondForce& force);
    /**
290
     * Execute the kernel to calculate the forces and/or energy.
291
     *
292
293
294
295
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
296
     */
297
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
298
299
300
301
302
303
304
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomBondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomBondForce& force);
305
306
307
308
private:
    int numBonds;
    bool hasInitializedKernel;
    OpenCLContext& cl;
309
    const System& system;
310
    OpenCLParameterSet* params;
311
    OpenCLArray* globals;
312
313
314
315
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
};

316
317
318
319
320
/**
 * This kernel is invoked by HarmonicAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcHarmonicAngleForceKernel : public CalcHarmonicAngleForceKernel {
public:
321
    OpenCLCalcHarmonicAngleForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcHarmonicAngleForceKernel(name, platform),
Peter Eastman's avatar
Peter Eastman committed
322
            hasInitializedKernel(false), cl(cl), system(system), params(NULL) {
323
324
325
326
327
328
329
330
331
332
    }
    ~OpenCLCalcHarmonicAngleForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the HarmonicAngleForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicAngleForce& force);
    /**
333
     * Execute the kernel to calculate the forces and/or energy.
334
     *
335
336
337
338
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
339
     */
340
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
341
342
343
344
345
346
347
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the HarmonicAngleForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const HarmonicAngleForce& force);
348
349
private:
    int numAngles;
350
    bool hasInitializedKernel;
351
    OpenCLContext& cl;
352
    const System& system;
353
    OpenCLArray* params;
354
355
};

356
357
358
359
360
/**
 * This kernel is invoked by CustomAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcCustomAngleForceKernel : public CalcCustomAngleForceKernel {
public:
361
    OpenCLCalcCustomAngleForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomAngleForceKernel(name, platform),
362
            hasInitializedKernel(false), cl(cl), system(system), params(NULL), globals(NULL) {
363
364
365
366
367
368
369
370
371
372
    }
    ~OpenCLCalcCustomAngleForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomAngleForce this kernel will be used for
     */
    void initialize(const System& system, const CustomAngleForce& force);
    /**
373
     * Execute the kernel to calculate the forces and/or energy.
374
     *
375
376
377
378
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
379
     */
380
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
381
382
383
384
385
386
387
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomAngleForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomAngleForce& force);
388
389
390
391
private:
    int numAngles;
    bool hasInitializedKernel;
    OpenCLContext& cl;
392
    const System& system;
393
    OpenCLParameterSet* params;
394
    OpenCLArray* globals;
395
396
397
398
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
};

399
400
401
402
403
/**
 * This kernel is invoked by PeriodicTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcPeriodicTorsionForceKernel : public CalcPeriodicTorsionForceKernel {
public:
404
    OpenCLCalcPeriodicTorsionForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcPeriodicTorsionForceKernel(name, platform),
Peter Eastman's avatar
Peter Eastman committed
405
            hasInitializedKernel(false), cl(cl), system(system), params(NULL) {
406
407
408
409
410
411
412
413
414
415
    }
    ~OpenCLCalcPeriodicTorsionForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the PeriodicTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const PeriodicTorsionForce& force);
    /**
416
     * Execute the kernel to calculate the forces and/or energy.
417
     *
418
419
420
421
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
422
     */
423
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
424
425
426
427
428
429
430
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the PeriodicTorsionForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const PeriodicTorsionForce& force);
431
432
private:
    int numTorsions;
433
    bool hasInitializedKernel;
434
    OpenCLContext& cl;
435
    const System& system;
436
    OpenCLArray* params;
437
438
};

439
440
441
442
443
/**
 * This kernel is invoked by RBTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcRBTorsionForceKernel : public CalcRBTorsionForceKernel {
public:
444
    OpenCLCalcRBTorsionForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcRBTorsionForceKernel(name, platform),
Peter Eastman's avatar
Peter Eastman committed
445
            hasInitializedKernel(false), cl(cl), system(system), params(NULL) {
446
447
448
449
450
451
452
453
454
455
    }
    ~OpenCLCalcRBTorsionForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the RBTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const RBTorsionForce& force);
    /**
456
     * Execute the kernel to calculate the forces and/or energy.
457
     *
458
459
460
461
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
462
     */
463
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
464
465
466
467
468
469
470
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the RBTorsionForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const RBTorsionForce& force);
471
472
private:
    int numTorsions;
473
    bool hasInitializedKernel;
474
    OpenCLContext& cl;
475
    const System& system;
476
    OpenCLArray* params;
477
478
};

479
480
481
482
483
/**
 * This kernel is invoked by CMAPTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcCMAPTorsionForceKernel : public CalcCMAPTorsionForceKernel {
public:
484
    OpenCLCalcCMAPTorsionForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCMAPTorsionForceKernel(name, platform),
485
            hasInitializedKernel(false), cl(cl), system(system), coefficients(NULL), mapPositions(NULL), torsionMaps(NULL) {
486
487
488
489
490
491
492
493
494
495
    }
    ~OpenCLCalcCMAPTorsionForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CMAPTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const CMAPTorsionForce& force);
    /**
496
     * Execute the kernel to calculate the forces and/or energy.
497
     *
498
499
500
501
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
502
     */
503
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
504
505
506
507
508
509
510
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CMAPTorsionForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CMAPTorsionForce& force);
511
512
513
514
private:
    int numTorsions;
    bool hasInitializedKernel;
    OpenCLContext& cl;
515
    const System& system;
516
    std::vector<mm_int2> mapPositionsVec;
517
518
519
    OpenCLArray* coefficients;
    OpenCLArray* mapPositions;
    OpenCLArray* torsionMaps;
520
521
};

522
523
524
525
526
/**
 * This kernel is invoked by CustomTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcCustomTorsionForceKernel : public CalcCustomTorsionForceKernel {
public:
527
    OpenCLCalcCustomTorsionForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomTorsionForceKernel(name, platform),
528
            hasInitializedKernel(false), cl(cl), system(system), params(NULL), globals(NULL) {
529
530
531
532
533
534
535
536
537
538
    }
    ~OpenCLCalcCustomTorsionForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const CustomTorsionForce& force);
    /**
539
     * Execute the kernel to calculate the forces and/or energy.
540
     *
541
542
543
544
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
545
     */
546
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
547
548
549
550
551
552
553
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomTorsionForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomTorsionForce& force);
554
555
556
557
private:
    int numTorsions;
    bool hasInitializedKernel;
    OpenCLContext& cl;
558
    const System& system;
559
    OpenCLParameterSet* params;
560
    OpenCLArray* globals;
561
562
563
564
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
};

565
566
567
568
569
/**
 * This kernel is invoked by NonbondedForce to calculate the forces acting on the system.
 */
class OpenCLCalcNonbondedForceKernel : public CalcNonbondedForceKernel {
public:
570
    OpenCLCalcNonbondedForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcNonbondedForceKernel(name, platform),
Peter Eastman's avatar
Peter Eastman committed
571
            hasInitializedKernel(false), cl(cl), sigmaEpsilon(NULL), exceptionParams(NULL), cosSinSums(NULL), pmeGrid(NULL),
572
            pmeGrid2(NULL), pmeBsplineModuliX(NULL), pmeBsplineModuliY(NULL), pmeBsplineModuliZ(NULL), pmeBsplineTheta(NULL),
573
            pmeAtomRange(NULL), pmeAtomGridIndex(NULL), sort(NULL), fft(NULL), pmeio(NULL) {
574
575
576
577
578
579
580
581
582
583
    }
    ~OpenCLCalcNonbondedForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the NonbondedForce this kernel will be used for
     */
    void initialize(const System& system, const NonbondedForce& force);
    /**
584
     * Execute the kernel to calculate the forces and/or energy.
585
     *
586
587
588
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
589
590
     * @param includeDirect  true if direct space interactions should be included
     * @param includeReciprocal  true if reciprocal space interactions should be included
591
     * @return the potential energy due to the force
592
     */
593
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy, bool includeDirect, bool includeReciprocal);
594
595
596
597
598
599
600
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the NonbondedForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const NonbondedForce& force);
601
602
603
604
605
606
607
608
609
    /**
     * Get the parameters being used for PME.
     * 
     * @param alpha   the separation parameter
     * @param nx      the number of grid points along the X axis
     * @param ny      the number of grid points along the Y axis
     * @param nz      the number of grid points along the Z axis
     */
    void getPMEParameters(double& alpha, int& nx, int& ny, int& nz) const;
610
private:
611
612
613
614
615
616
617
618
619
    class SortTrait : public OpenCLSort::SortTrait {
        int getDataSize() const {return 8;}
        int getKeySize() const {return 4;}
        const char* getDataType() const {return "int2";}
        const char* getKeyType() const {return "int";}
        const char* getMinKey() const {return "INT_MIN";}
        const char* getMaxKey() const {return "INT_MAX";}
        const char* getMaxValue() const {return "(int2) (INT_MAX, INT_MAX)";}
        const char* getSortKey() const {return "value.y";}
620
    };
621
622
623
    class PmeIO;
    class PmePreComputation;
    class PmePostComputation;
624
625
    class SyncQueuePreComputation;
    class SyncQueuePostComputation;
626
    OpenCLContext& cl;
627
    bool hasInitializedKernel;
628
629
630
631
632
633
634
635
636
637
638
    OpenCLArray* sigmaEpsilon;
    OpenCLArray* exceptionParams;
    OpenCLArray* cosSinSums;
    OpenCLArray* pmeGrid;
    OpenCLArray* pmeGrid2;
    OpenCLArray* pmeBsplineModuliX;
    OpenCLArray* pmeBsplineModuliY;
    OpenCLArray* pmeBsplineModuliZ;
    OpenCLArray* pmeBsplineTheta;
    OpenCLArray* pmeAtomRange;
    OpenCLArray* pmeAtomGridIndex;
639
    OpenCLSort* sort;
640
641
    cl::CommandQueue pmeQueue;
    cl::Event pmeSyncEvent;
642
    OpenCLFFT3D* fft;
643
644
    Kernel cpuPme;
    PmeIO* pmeio;
645
646
    cl::Kernel ewaldSumsKernel;
    cl::Kernel ewaldForcesKernel;
647
648
    cl::Kernel pmeGridIndexKernel;
    cl::Kernel pmeAtomRangeKernel;
649
    cl::Kernel pmeZIndexKernel;
650
651
    cl::Kernel pmeUpdateBsplinesKernel;
    cl::Kernel pmeSpreadChargeKernel;
652
    cl::Kernel pmeFinishSpreadChargeKernel;
653
    cl::Kernel pmeConvolutionKernel;
654
    cl::Kernel pmeEvalEnergyKernel;
655
656
    cl::Kernel pmeInterpolateForceKernel;
    std::map<std::string, std::string> pmeDefines;
657
    std::vector<std::pair<int, int> > exceptionAtoms;
658
    double ewaldSelfEnergy, dispersionCoefficient, alpha;
659
    int gridSizeX, gridSizeY, gridSizeZ;
660
    bool hasCoulomb, hasLJ, usePmeQueue;
661
    NonbondedMethod nonbondedMethod;
662
    static const int PmeOrder = 5;
663
664
};

665
666
667
668
669
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
670
    OpenCLCalcCustomNonbondedForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomNonbondedForceKernel(name, platform),
671
            cl(cl), params(NULL), globals(NULL), interactionGroupData(NULL), forceCopy(NULL), system(system), hasInitializedKernel(false) {
672
673
674
675
676
677
678
679
680
681
    }
    ~OpenCLCalcCustomNonbondedForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomNonbondedForce this kernel will be used for
     */
    void initialize(const System& system, const CustomNonbondedForce& force);
    /**
682
     * Execute the kernel to calculate the forces and/or energy.
683
     *
684
685
686
687
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
688
     */
689
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
690
691
692
693
694
695
696
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomNonbondedForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomNonbondedForce& force);
697
private:
698
    void initInteractionGroups(const CustomNonbondedForce& force, const std::string& interactionSource);
699
    OpenCLContext& cl;
700
    OpenCLParameterSet* params;
701
    OpenCLArray* globals;
702
703
704
    OpenCLArray* interactionGroupData;
    cl::Kernel interactionGroupKernel;
    std::vector<void*> interactionGroupArgs;
705
706
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
707
    std::vector<OpenCLArray*> tabulatedFunctions;
708
    double longRangeCoefficient;
709
710
    bool hasInitializedLongRangeCorrection, hasInitializedKernel;
    int numGroupThreadBlocks;
711
    CustomNonbondedForce* forceCopy;
712
    const System& system;
713
};
714
715
716
717
718
719

/**
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
 */
class OpenCLCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
public:
720
    OpenCLCalcGBSAOBCForceKernel(std::string name, const Platform& platform, OpenCLContext& cl) : CalcGBSAOBCForceKernel(name, platform), cl(cl),
721
722
            hasCreatedKernels(false), params(NULL), bornSum(NULL), longBornSum(NULL), bornRadii(NULL), bornForce(NULL),
            longBornForce(NULL), obcChain(NULL) {
723
724
725
726
727
728
729
730
731
732
    }
    ~OpenCLCalcGBSAOBCForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the GBSAOBCForce this kernel will be used for
     */
    void initialize(const System& system, const GBSAOBCForce& force);
    /**
733
     * Execute the kernel to calculate the forces and/or energy.
734
     *
735
736
737
738
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
739
     */
740
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
741
742
743
744
745
746
747
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the GBSAOBCForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const GBSAOBCForce& force);
748
private:
749
    double prefactor, surfaceAreaFactor, cutoff;
750
    bool hasCreatedKernels;
751
    int maxTiles;
752
    OpenCLContext& cl;
753
754
755
756
757
758
759
    OpenCLArray* params;
    OpenCLArray* bornSum;
    OpenCLArray* longBornSum;
    OpenCLArray* bornRadii;
    OpenCLArray* bornForce;
    OpenCLArray* longBornForce;
    OpenCLArray* obcChain;
760
761
    cl::Kernel computeBornSumKernel;
    cl::Kernel reduceBornSumKernel;
762
763
    cl::Kernel force1Kernel;
    cl::Kernel reduceBornForceKernel;
764
};
765

766
767
768
769
770
/**
 * This kernel is invoked by CustomGBForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomGBForceKernel : public CalcCustomGBForceKernel {
public:
771
    OpenCLCalcCustomGBForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomGBForceKernel(name, platform),
772
            hasInitializedKernels(false), cl(cl), params(NULL), computedValues(NULL), energyDerivs(NULL), energyDerivChain(NULL), longEnergyDerivs(NULL), globals(NULL),
773
            valueBuffers(NULL), longValueBuffers(NULL), system(system) {
774
775
776
777
778
779
780
781
782
783
    }
    ~OpenCLCalcCustomGBForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomGBForce this kernel will be used for
     */
    void initialize(const System& system, const CustomGBForce& force);
    /**
784
     * Execute the kernel to calculate the forces and/or energy.
785
     *
786
787
788
789
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
790
     */
791
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
792
793
794
795
796
797
798
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomGBForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomGBForce& force);
799
private:
800
    double cutoff;
Peter Eastman's avatar
Peter Eastman committed
801
    bool hasInitializedKernels, needParameterGradient;
802
    int maxTiles, numComputedValues;
803
804
805
    OpenCLContext& cl;
    OpenCLParameterSet* params;
    OpenCLParameterSet* computedValues;
806
    OpenCLParameterSet* energyDerivs;
807
    OpenCLParameterSet* energyDerivChain;
808
809
810
811
    OpenCLArray* longEnergyDerivs;
    OpenCLArray* globals;
    OpenCLArray* valueBuffers;
    OpenCLArray* longValueBuffers;
812
813
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
814
    std::vector<OpenCLArray*> tabulatedFunctions;
Peter Eastman's avatar
Peter Eastman committed
815
    std::vector<bool> pairValueUsesParam, pairEnergyUsesParam, pairEnergyUsesValue;
816
    const System& system;
Peter Eastman's avatar
Peter Eastman committed
817
    cl::Kernel pairValueKernel, perParticleValueKernel, pairEnergyKernel, perParticleEnergyKernel, gradientChainRuleKernel;
818
819
    std::string pairValueSrc, pairEnergySrc;
    std::map<std::string, std::string> pairValueDefines, pairEnergyDefines;
820
821
};

822
823
824
825
826
/**
 * This kernel is invoked by CustomExternalForce to calculate the forces acting on the system and the energy of the system.
 */
class OpenCLCalcCustomExternalForceKernel : public CalcCustomExternalForceKernel {
public:
827
    OpenCLCalcCustomExternalForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomExternalForceKernel(name, platform),
828
            hasInitializedKernel(false), cl(cl), system(system), params(NULL), globals(NULL) {
829
830
831
832
833
834
835
836
837
838
    }
    ~OpenCLCalcCustomExternalForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomExternalForce this kernel will be used for
     */
    void initialize(const System& system, const CustomExternalForce& force);
    /**
839
     * Execute the kernel to calculate the forces and/or energy.
840
     *
841
842
843
844
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
845
     */
846
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
847
848
849
850
851
852
853
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomExternalForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomExternalForce& force);
854
855
856
857
private:
    int numParticles;
    bool hasInitializedKernel;
    OpenCLContext& cl;
858
    const System& system;
859
    OpenCLParameterSet* params;
860
    OpenCLArray* globals;
861
862
863
864
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
};

865
866
867
868
869
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
870
    OpenCLCalcCustomHbondForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomHbondForceKernel(name, platform),
871
            hasInitializedKernel(false), cl(cl), donorParams(NULL), acceptorParams(NULL), donors(NULL), acceptors(NULL),
872
            donorBufferIndices(NULL), acceptorBufferIndices(NULL), globals(NULL), donorExclusions(NULL), acceptorExclusions(NULL), system(system) {
873
874
875
876
877
878
879
880
881
882
    }
    ~OpenCLCalcCustomHbondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomHbondForce this kernel will be used for
     */
    void initialize(const System& system, const CustomHbondForce& force);
    /**
883
     * Execute the kernel to calculate the forces and/or energy.
884
     *
885
886
887
888
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
889
     */
890
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
891
892
893
894
895
896
897
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomHbondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomHbondForce& force);
898
899
900
901
902
903
private:
    int numDonors, numAcceptors;
    bool hasInitializedKernel;
    OpenCLContext& cl;
    OpenCLParameterSet* donorParams;
    OpenCLParameterSet* acceptorParams;
904
905
906
907
908
909
910
    OpenCLArray* globals;
    OpenCLArray* donors;
    OpenCLArray* acceptors;
    OpenCLArray* donorBufferIndices;
    OpenCLArray* acceptorBufferIndices;
    OpenCLArray* donorExclusions;
    OpenCLArray* acceptorExclusions;
911
912
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
913
    std::vector<OpenCLArray*> tabulatedFunctions;
914
    const System& system;
915
    cl::Kernel donorKernel, acceptorKernel;
916
917
};

918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
/**
 * This kernel is invoked by CustomCentroidBondForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomCentroidBondForceKernel : public CalcCustomCentroidBondForceKernel {
public:
    OpenCLCalcCustomCentroidBondForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomCentroidBondForceKernel(name, platform),
            cl(cl), params(NULL), globals(NULL), groupParticles(NULL), groupWeights(NULL), groupOffsets(NULL), groupForces(NULL), bondGroups(NULL), centerPositions(NULL), system(system) {
    }
    ~OpenCLCalcCustomCentroidBondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomCentroidBondForce this kernel will be used for
     */
    void initialize(const System& system, const CustomCentroidBondForce& force);
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
     */
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomCentroidBondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomCentroidBondForce& force);

private:
    int numGroups, numBonds;
    OpenCLContext& cl;
    OpenCLParameterSet* params;
    OpenCLArray* globals;
    OpenCLArray* groupParticles;
    OpenCLArray* groupWeights;
    OpenCLArray* groupOffsets;
    OpenCLArray* groupForces;
    OpenCLArray* bondGroups;
    OpenCLArray* centerPositions;
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
    std::vector<OpenCLArray*> tabulatedFunctions;
    cl::Kernel computeCentersKernel, groupForcesKernel, applyForcesKernel;
    const System& system;
};

969
970
971
972
973
/**
 * This kernel is invoked by CustomCompoundBondForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomCompoundBondForceKernel : public CalcCustomCompoundBondForceKernel {
public:
974
    OpenCLCalcCustomCompoundBondForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomCompoundBondForceKernel(name, platform),
975
            cl(cl), params(NULL), globals(NULL), system(system) {
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
    }
    ~OpenCLCalcCustomCompoundBondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomCompoundBondForce this kernel will be used for
     */
    void initialize(const System& system, const CustomCompoundBondForce& force);
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
     */
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
994
995
996
997
998
999
1000
1001
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomCompoundBondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomCompoundBondForce& force);

1002
1003
1004
1005
private:
    int numBonds;
    OpenCLContext& cl;
    OpenCLParameterSet* params;
1006
    OpenCLArray* globals;
1007
1008
    std::vector<std::string> globalParamNames;
    std::vector<cl_float> globalParamValues;
1009
    std::vector<OpenCLArray*> tabulatedFunctions;
1010
    const System& system;
1011
1012
};

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
/**
 * This kernel is invoked by CustomManyParticleForce to calculate the forces acting on the system.
 */
class OpenCLCalcCustomManyParticleForceKernel : public CalcCustomManyParticleForceKernel {
public:
    OpenCLCalcCustomManyParticleForceKernel(std::string name, const Platform& platform, OpenCLContext& cl, const System& system) : CalcCustomManyParticleForceKernel(name, platform),
            hasInitializedKernel(false), cl(cl), params(NULL), globals(NULL), particleTypes(NULL), orderIndex(NULL), particleOrder(NULL), exclusions(NULL),
            exclusionStartIndex(NULL), blockCenter(NULL), blockBoundingBox(NULL), neighborPairs(NULL), numNeighborPairs(NULL), neighborStartIndex(NULL),
            numNeighborsForAtom(NULL), neighbors(NULL), system(system) {
    }
    ~OpenCLCalcCustomManyParticleForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomManyParticleForce this kernel will be used for
     */
    void initialize(const System& system, const CustomManyParticleForce& force);
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
     */
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomManyParticleForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomManyParticleForce& force);

private:
    OpenCLContext& cl;
    bool hasInitializedKernel;
    NonbondedMethod nonbondedMethod;
    int maxNeighborPairs, forceWorkgroupSize, findNeighborsWorkgroupSize;
    OpenCLParameterSet* params;
    OpenCLArray* globals;
    OpenCLArray* particleTypes;
    OpenCLArray* orderIndex;
    OpenCLArray* particleOrder;
    OpenCLArray* exclusions;
    OpenCLArray* exclusionStartIndex;
    OpenCLArray* blockCenter;
    OpenCLArray* blockBoundingBox;
    OpenCLArray* neighborPairs;
    OpenCLArray* numNeighborPairs;
    OpenCLArray* neighborStartIndex;
    OpenCLArray* numNeighborsForAtom;
    OpenCLArray* neighbors;
    std::vector<std::string> globalParamNames;
    std::vector<float> globalParamValues;
    std::vector<OpenCLArray*> tabulatedFunctions;
    const System& system;
    cl::Kernel forceKernel, blockBoundsKernel, neighborsKernel, startIndicesKernel, copyPairsKernel;
};

1074
1075
1076
1077
1078
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class OpenCLIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
1079
    OpenCLIntegrateVerletStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateVerletStepKernel(name, platform), cl(cl),
1080
            hasInitializedKernels(false) {
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
    }
    ~OpenCLIntegrateVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
     */
    void initialize(const System& system, const VerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
     */
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
1097
1098
1099
1100
1101
1102
1103
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const VerletIntegrator& integrator);
1104
private:
1105
    OpenCLContext& cl;
1106
    double prevStepSize;
1107
    bool hasInitializedKernels;
1108
1109
1110
1111
1112
1113
1114
1115
1116
    cl::Kernel kernel1, kernel2;
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class OpenCLIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
    OpenCLIntegrateLangevinStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateLangevinStepKernel(name, platform), cl(cl),
1117
            hasInitializedKernels(false), params(NULL) {
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
    }
    ~OpenCLIntegrateLangevinStepKernel();
    /**
     * Initialize the kernel, setting up the particle masses.
     *
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
     */
    void initialize(const System& system, const LangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
     */
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
1134
1135
1136
1137
1138
1139
1140
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const LangevinIntegrator& integrator);
1141
1142
1143
private:
    OpenCLContext& cl;
    double prevTemp, prevFriction, prevStepSize;
1144
    bool hasInitializedKernels;
1145
    OpenCLArray* params;
1146
    cl::Kernel kernel1, kernel2;
1147
1148
};

1149
1150
1151
1152
1153
/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class OpenCLIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
1154
1155
    OpenCLIntegrateBrownianStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateBrownianStepKernel(name, platform), cl(cl),
            hasInitializedKernels(false), prevTemp(-1), prevFriction(-1), prevStepSize(-1) {
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
    }
    ~OpenCLIntegrateBrownianStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
     */
    void initialize(const System& system, const BrownianIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
     */
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
1172
1173
1174
1175
1176
1177
1178
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const BrownianIntegrator& integrator);
1179
1180
1181
1182
1183
1184
private:
    OpenCLContext& cl;
    double prevTemp, prevFriction, prevStepSize;
    bool hasInitializedKernels;
    cl::Kernel kernel1, kernel2;
};
1185
1186
1187
1188
1189
1190
1191

/**
 * This kernel is invoked by VariableVerletIntegrator to take one time step.
 */
class OpenCLIntegrateVariableVerletStepKernel : public IntegrateVariableVerletStepKernel {
public:
    OpenCLIntegrateVariableVerletStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateVariableVerletStepKernel(name, platform), cl(cl),
1192
            hasInitializedKernels(false) {
1193
1194
1195
1196
1197
1198
    }
    ~OpenCLIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1199
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1200
1201
1202
1203
1204
1205
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1206
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1207
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1208
     * @return the size of the step that was taken
1209
     */
1210
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1211
1212
1213
1214
1215
1216
1217
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the VariableVerletIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const VariableVerletIntegrator& integrator);
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
private:
    OpenCLContext& cl;
    bool hasInitializedKernels;
    int blockSize;
    cl::Kernel kernel1, kernel2, selectSizeKernel;
};

/**
 * This kernel is invoked by VariableLangevinIntegrator to take one time step.
 */
class OpenCLIntegrateVariableLangevinStepKernel : public IntegrateVariableLangevinStepKernel {
public:
    OpenCLIntegrateVariableLangevinStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateVariableLangevinStepKernel(name, platform), cl(cl),
1231
            hasInitializedKernels(false), params(NULL) {
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
    }
    ~OpenCLIntegrateVariableLangevinStepKernel();
    /**
     * Initialize the kernel, setting up the particle masses.
     *
     * @param system     the System this kernel will be applied to
     * @param integrator the VariableLangevinIntegrator this kernel will be used for
     */
    void initialize(const System& system, const VariableLangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the VariableLangevinIntegrator this kernel is being used for
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1247
     * @return the size of the step that was taken
1248
     */
1249
    double execute(ContextImpl& context, const VariableLangevinIntegrator& integrator, double maxTime);
1250
1251
1252
1253
1254
1255
1256
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the VariableLangevinIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const VariableLangevinIntegrator& integrator);
1257
1258
1259
1260
private:
    OpenCLContext& cl;
    bool hasInitializedKernels;
    int blockSize;
1261
    OpenCLArray* params;
1262
    cl::Kernel kernel1, kernel2, selectSizeKernel;
1263
1264
    double prevTemp, prevFriction, prevErrorTol;
};
1265

1266
1267
1268
1269
1270
/**
 * This kernel is invoked by CustomIntegrator to take one time step.
 */
class OpenCLIntegrateCustomStepKernel : public IntegrateCustomStepKernel {
public:
1271
    enum GlobalTargetType {DT, VARIABLE, PARAMETER};
1272
    OpenCLIntegrateCustomStepKernel(std::string name, const Platform& platform, OpenCLContext& cl) : IntegrateCustomStepKernel(name, platform), cl(cl),
1273
1274
            hasInitializedKernels(false), localValuesAreCurrent(false), globalValues(NULL), sumBuffer(NULL), summedValue(NULL), uniformRandoms(NULL),
            randomSeed(NULL), perDofValues(NULL) {
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
    }
    ~OpenCLIntegrateCustomStepKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     * @param integrator the CustomIntegrator this kernel will be used for
     */
    void initialize(const System& system, const CustomIntegrator& integrator);
    /**
     * Execute the kernel.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the CustomIntegrator this kernel is being used for
     * @param forcesAreValid if the context has been modified since the last time step, this will be
     *                       false to show that cached forces are invalid and must be recalculated.
     *                       On exit, this should specify whether the cached forces are valid at the
     *                       end of the step.
     */
    void execute(ContextImpl& context, CustomIntegrator& integrator, bool& forcesAreValid);
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the CustomIntegrator this kernel is being used for
     * @param forcesAreValid if the context has been modified since the last time step, this will be
     *                       false to show that cached forces are invalid and must be recalculated.
     *                       On exit, this should specify whether the cached forces are valid at the
     *                       end of the step.
     */
    double computeKineticEnergy(ContextImpl& context, CustomIntegrator& integrator, bool& forcesAreValid);
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
    /**
     * Get the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    on exit, this contains the values
     */
    void getGlobalVariables(ContextImpl& context, std::vector<double>& values) const;
    /**
     * Set the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    a vector containing the values
     */
    void setGlobalVariables(ContextImpl& context, const std::vector<double>& values);
    /**
     * Get the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    on exit, this contains the values
     */
    void getPerDofVariable(ContextImpl& context, int variable, std::vector<Vec3>& values) const;
    /**
     * Set the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    a vector containing the values
     */
    void setPerDofVariable(ContextImpl& context, int variable, const std::vector<Vec3>& values);
private:
1337
    class ReorderListener;
1338
    class GlobalTarget;
1339
    std::string createPerDofComputation(const std::string& variable, const Lepton::ParsedExpression& expr, int component, CustomIntegrator& integrator, const std::string& forceName, const std::string& energyName);
1340
    void prepareForComputation(ContextImpl& context, CustomIntegrator& integrator, bool& forcesAreValid);
1341
    void recordGlobalValue(double value, GlobalTarget target);
1342
    void recordChangedParameters(ContextImpl& context);
1343
    bool evaluateCondition(int step);
1344
    OpenCLContext& cl;
Peter Eastman's avatar
Peter Eastman committed
1345
    double prevStepSize, energy;
1346
    float energyFloat;
1347
    int numGlobalVariables;
peastman's avatar
peastman committed
1348
    bool hasInitializedKernels, deviceValuesAreCurrent, deviceGlobalsAreCurrent, modifiesParameters, keNeedsForce, hasAnyConstraints;
1349
    mutable bool localValuesAreCurrent;
1350
1351
    OpenCLArray* globalValues;
    OpenCLArray* sumBuffer;
1352
    OpenCLArray* summedValue;
1353
1354
    OpenCLArray* uniformRandoms;
    OpenCLArray* randomSeed;
1355
1356
    std::map<int, OpenCLArray*> savedForces;
    std::set<int> validSavedForces;
1357
    OpenCLParameterSet* perDofValues;
1358
1359
    mutable std::vector<std::vector<cl_float> > localPerDofValuesFloat;
    mutable std::vector<std::vector<cl_double> > localPerDofValuesDouble;
1360
1361
1362
    std::vector<float> globalValuesFloat;
    std::vector<double> globalValuesDouble;
    std::vector<double> initialGlobalVariables;
1363
    std::vector<std::vector<cl::Kernel> > kernels;
Peter Eastman's avatar
Peter Eastman committed
1364
    cl::Kernel randomKernel, kineticEnergyKernel, sumKineticEnergyKernel;
1365
    std::vector<CustomIntegrator::ComputationType> stepType;
1366
1367
1368
1369
    std::vector<CustomIntegratorUtilities::Comparison> comparisons;
    std::vector<std::vector<Lepton::CompiledExpression> > globalExpressions;
    CompiledExpressionSet expressionSet;
    std::vector<bool> needsGlobals;
1370
1371
    std::vector<bool> needsForces;
    std::vector<bool> needsEnergy;
1372
    std::vector<bool> computeBothForceAndEnergy;
1373
    std::vector<bool> invalidatesForces;
1374
    std::vector<bool> merged;
1375
1376
    std::vector<int> forceGroupFlags;
    std::vector<int> blockEnd;
1377
1378
    std::vector<int> requiredGaussian;
    std::vector<int> requiredUniform;
1379
1380
1381
1382
    std::vector<int> stepEnergyVariableIndex;
    std::vector<int> globalVariableIndex;
    std::vector<int> parameterVariableIndex;
    int gaussianVariableIndex, uniformVariableIndex, dtVariableIndex;
1383
    std::vector<std::string> parameterNames;
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
    std::vector<GlobalTarget> stepTarget;
};

class OpenCLIntegrateCustomStepKernel::GlobalTarget {
public:
    OpenCLIntegrateCustomStepKernel::GlobalTargetType type;
    int variableIndex;
    GlobalTarget() {
    }
    GlobalTarget(OpenCLIntegrateCustomStepKernel::GlobalTargetType type, int variableIndex) : type(type), variableIndex(variableIndex) {
    }
1395
1396
};

1397
1398
1399
1400
1401
1402
/**
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
 */
class OpenCLApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
    OpenCLApplyAndersenThermostatKernel(std::string name, const Platform& platform, OpenCLContext& cl) : ApplyAndersenThermostatKernel(name, platform), cl(cl),
1403
            hasInitializedKernels(false), atomGroups(NULL) {
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
    }
    ~OpenCLApplyAndersenThermostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
     */
    void initialize(const System& system, const AndersenThermostat& thermostat);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     */
    void execute(ContextImpl& context);
private:
    OpenCLContext& cl;
    bool hasInitializedKernels;
    int randomSeed;
1423
    OpenCLArray* atomGroups;
1424
    cl::Kernel kernel;
1425
1426
1427
1428
1429
1430
1431
1432
};

/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class OpenCLApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
    OpenCLApplyMonteCarloBarostatKernel(std::string name, const Platform& platform, OpenCLContext& cl) : ApplyMonteCarloBarostatKernel(name, platform), cl(cl),
1433
            hasInitializedKernels(false), savedPositions(NULL), moleculeAtoms(NULL), moleculeStartIndex(NULL) {
1434
1435
1436
1437
1438
1439
1440
1441
    }
    ~OpenCLApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
1442
    void initialize(const System& system, const Force& barostat);
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
    /**
     * Attempt a Monte Carlo step, scaling particle positions (or cluster centers) by a specified value.
     * This version scales the x, y, and z positions independently.
     * This is called BEFORE the periodic box size is modified.  It should begin by translating each particle
     * or cluster into the first periodic box, so that coordinates will still be correct after the box size
     * is changed.
     *
     * @param context    the context in which to execute this kernel
     * @param scaleX     the scale factor by which to multiply particle x-coordinate
     * @param scaleY     the scale factor by which to multiply particle y-coordinate
     * @param scaleZ     the scale factor by which to multiply particle z-coordinate
     */
1455
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
    /**
     * Reject the most recent Monte Carlo step, restoring the particle positions to where they were before
     * scaleCoordinates() was last called.
     *
     * @param context    the context in which to execute this kernel
     */
    void restoreCoordinates(ContextImpl& context);
private:
    OpenCLContext& cl;
    bool hasInitializedKernels;
    int numMolecules;
1467
1468
1469
    OpenCLArray* savedPositions;
    OpenCLArray* moleculeAtoms;
    OpenCLArray* moleculeStartIndex;
1470
    cl::Kernel kernel;
1471
    std::vector<int> lastAtomOrder;
1472
};
1473

1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class OpenCLRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
    OpenCLRemoveCMMotionKernel(std::string name, const Platform& platform, OpenCLContext& cl) : RemoveCMMotionKernel(name, platform), cl(cl), cmMomentum(NULL) {
    }
    ~OpenCLRemoveCMMotionKernel();
    /**
     * Initialize the kernel, setting up the particle masses.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
     */
    void initialize(const System& system, const CMMotionRemover& force);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     */
    void execute(ContextImpl& context);
private:
    OpenCLContext& cl;
    int frequency;
1498
    OpenCLArray* cmMomentum;
1499
1500
    cl::Kernel kernel1, kernel2;
};
1501
1502
1503
1504

} // namespace OpenMM

#endif /*OPENMM_OPENCLKERNELS_H_*/