ReferenceKernels.h 42.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
#ifndef OPENMM_REFERENCEKERNELS_H_
#define OPENMM_REFERENCEKERNELS_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-2009 Stanford University and the Authors.      *
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 * Authors: Peter Eastman                                                     *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included in *
 * all copies or substantial portions of the Software.                        *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,    *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR      *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE  *
 * USE OR OTHER DEALINGS IN THE SOFTWARE.                                     *
 * -------------------------------------------------------------------------- */

35
#include "ReferencePlatform.h"
36
#include "openmm/kernels.h"
37
#include "SimTKUtilities/SimTKOpenMMRealType.h"
38
#include "SimTKReference/ReferenceNeighborList.h"
39
#include "lepton/ExpressionProgram.h"
40

41
class CpuObc;
Mark Friedrichs's avatar
Mark Friedrichs committed
42
class CpuGBVI;
43
class ReferenceAndersenThermostat;
44
class ReferenceCustomHbondIxn;
45
class ReferenceBrownianDynamics;
46
class ReferenceStochasticDynamics;
47
class ReferenceConstraintAlgorithm;
48
class ReferenceMonteCarloBarostat;
49
class ReferenceVariableStochasticDynamics;
50
class ReferenceVariableVerletDynamics;
51
class ReferenceVerletDynamics;
52
class ReferenceCustomDynamics;
53

54
55
namespace OpenMM {

56
/**
57
58
59
 * 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.
60
 */
61
class ReferenceCalcForcesAndEnergyKernel : public CalcForcesAndEnergyKernel {
62
public:
63
    ReferenceCalcForcesAndEnergyKernel(std::string name, const Platform& platform) : CalcForcesAndEnergyKernel(name, platform) {
64
65
66
67
68
69
70
71
    }
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
72
     * This is called at the beginning of each force/energy computation, before calcForcesAndEnergy() has been called on
73
74
     * any ForceImpl.
     *
75
76
77
     * @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
78
     */
79
    void beginComputation(ContextImpl& context, bool includeForce, bool includeEnergy);
80
    /**
81
     * This is called at the end of each force/energy computation, after calcForcesAndEnergy() has been called on
82
83
     * every ForceImpl.
     *
84
85
86
     * @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
87
     * @return the potential energy of the system.  This value is added to all values returned by ForceImpls'
88
     * calcForcesAndEnergy() methods.  That is, each force kernel may <i>either</i> return its contribution to the
89
     * energy directly, <i>or</i> add it to an internal buffer so that it will be included here.
90
     */
91
    double finishComputation(ContextImpl& context, bool includeForce, bool includeEnergy);
92
93
};

94
/**
95
96
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
97
 */
98
class ReferenceUpdateStateDataKernel : public UpdateStateDataKernel {
99
public:
100
    ReferenceUpdateStateDataKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : UpdateStateDataKernel(name, platform), data(data) {
101
102
103
104
105
106
107
108
109
110
111
112
    }
    /**
     * 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
     */
113
    double getTime(const ContextImpl& context) const;
114
115
116
117
118
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
119
    void setTime(ContextImpl& context, double time);
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
    /**
     * 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);
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
    /**
     * 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;
166
167
168
169
private:
    ReferencePlatform::PlatformData& data;
};

170
171
172
173
174
175
/**
 * This kernel modifies the positions of particles to enforce distance constraints.
 */
class ReferenceApplyConstraintsKernel : public ApplyConstraintsKernel {
public:
    ReferenceApplyConstraintsKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) :
176
            ApplyConstraintsKernel(name, platform), data(data), constraints(0), constraintDistances(0), constraintIndices(0) {
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    }
    ~ReferenceApplyConstraintsKernel();
    /**
     * 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);
private:
    ReferencePlatform::PlatformData& data;
    ReferenceConstraintAlgorithm* constraints;
195
196
    std::vector<RealOpenMM> masses;
    std::vector<RealOpenMM> inverseMasses;
197
198
199
200
201
    RealOpenMM* constraintDistances;
    int** constraintIndices;
    int numConstraints;
};

202
/**
203
 * This kernel is invoked by HarmonicBondForce to calculate the forces acting on the system and the energy of the system.
204
 */
205
class ReferenceCalcHarmonicBondForceKernel : public CalcHarmonicBondForceKernel {
206
public:
207
    ReferenceCalcHarmonicBondForceKernel(std::string name, const Platform& platform) : CalcHarmonicBondForceKernel(name, platform) {
208
    }
209
    ~ReferenceCalcHarmonicBondForceKernel();
210
    /**
211
     * Initialize the kernel.
212
     * 
213
     * @param system     the System this kernel will be applied to
214
215
216
217
     * @param force      the HarmonicBondForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicBondForce& force);
    /**
218
219
220
221
222
223
     * 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
224
     */
225
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
226
227
228
229
230
231
private:
    int numBonds;
    int **bondIndexArray;
    RealOpenMM **bondParamArray;
};

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/**
 * This kernel is invoked by CustomBondForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomBondForceKernel : public CalcCustomBondForceKernel {
public:
    ReferenceCalcCustomBondForceKernel(std::string name, const Platform& platform) : CalcCustomBondForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomBondForceKernel();
    /**
     * 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);
    /**
248
     * Execute the kernel to calculate the forces and/or energy.
249
     *
250
251
252
253
     * @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
254
     */
255
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
256
257
258
259
260
261
262
263
private:
    int numBonds;
    int **bondIndexArray;
    RealOpenMM **bondParamArray;
    Lepton::ExpressionProgram energyExpression, forceExpression;
    std::vector<std::string> parameterNames, globalParameterNames;
};

264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/**
 * This kernel is invoked by HarmonicAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcHarmonicAngleForceKernel : public CalcHarmonicAngleForceKernel {
public:
    ReferenceCalcHarmonicAngleForceKernel(std::string name, const Platform& platform) : CalcHarmonicAngleForceKernel(name, platform) {
    }
    ~ReferenceCalcHarmonicAngleForceKernel();
    /**
     * 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);
    /**
280
281
282
283
284
285
     * 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
286
     */
287
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
288
289
290
291
292
293
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
};

294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
/**
 * This kernel is invoked by CustomAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomAngleForceKernel : public CalcCustomAngleForceKernel {
public:
    ReferenceCalcCustomAngleForceKernel(std::string name, const Platform& platform) : CalcCustomAngleForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomAngleForceKernel();
    /**
     * 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);
    /**
310
     * Execute the kernel to calculate the forces and/or energy.
311
     *
312
313
314
315
     * @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
316
     */
317
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
318
319
320
321
322
323
324
325
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
    Lepton::ExpressionProgram energyExpression, forceExpression;
    std::vector<std::string> parameterNames, globalParameterNames;
};

326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
/**
 * This kernel is invoked by PeriodicTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcPeriodicTorsionForceKernel : public CalcPeriodicTorsionForceKernel {
public:
    ReferenceCalcPeriodicTorsionForceKernel(std::string name, const Platform& platform) : CalcPeriodicTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcPeriodicTorsionForceKernel();
    /**
     * 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);
    /**
342
343
344
345
346
347
     * 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
348
     */
349
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
};

/**
 * This kernel is invoked by RBTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcRBTorsionForceKernel : public CalcRBTorsionForceKernel {
public:
    ReferenceCalcRBTorsionForceKernel(std::string name, const Platform& platform) : CalcRBTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcRBTorsionForceKernel();
    /**
     * 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);
    /**
372
373
374
375
376
377
     * 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
378
     */
379
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
380
381
382
383
384
385
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
};

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
/**
 * This kernel is invoked by CMAPTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCMAPTorsionForceKernel : public CalcCMAPTorsionForceKernel {
public:
    ReferenceCalcCMAPTorsionForceKernel(std::string name, const Platform& platform) : CalcCMAPTorsionForceKernel(name, platform) {
    }
    /**
     * 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);
    /**
401
     * Execute the kernel to calculate the forces and/or energy.
402
     *
403
404
405
406
     * @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
407
     */
408
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
409
410
411
412
413
414
private:
    std::vector<std::vector<std::vector<RealOpenMM> > > coeff;
    std::vector<int> torsionMaps;
    std::vector<std::vector<int> > torsionIndices;
};

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
/**
 * This kernel is invoked by CustomTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomTorsionForceKernel : public CalcCustomTorsionForceKernel {
public:
    ReferenceCalcCustomTorsionForceKernel(std::string name, const Platform& platform) : CalcCustomTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomTorsionForceKernel();
    /**
     * 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);
    /**
431
     * Execute the kernel to calculate the forces and/or energy.
432
     *
433
434
435
436
     * @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
437
     */
438
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
439
440
441
442
443
444
445
446
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
    Lepton::ExpressionProgram energyExpression, forceExpression;
    std::vector<std::string> parameterNames, globalParameterNames;
};

447
448
449
450
451
452
453
454
455
456
457
458
459
/**
 * This kernel is invoked by NonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcNonbondedForceKernel : public CalcNonbondedForceKernel {
public:
    ReferenceCalcNonbondedForceKernel(std::string name, const Platform& platform) : CalcNonbondedForceKernel(name, platform) {
    }
    ~ReferenceCalcNonbondedForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     * @param force      the NonbondedForce this kernel will be used for
460
     */
461
    void initialize(const System& system, const NonbondedForce& force);
462
    /**
463
464
465
466
467
468
     * 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
469
     */
470
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
471
private:
Peter Eastman's avatar
Peter Eastman committed
472
    int numParticles, num14;
473
    int **exclusionArray, **bonded14IndexArray;
Peter Eastman's avatar
Peter Eastman committed
474
    RealOpenMM **particleParamArray, **bonded14ParamArray;
475
    RealOpenMM nonbondedCutoff, rfDielectric, ewaldAlpha, dispersionCoefficient;
476
    int kmax[3], gridSize[3];
477
478
479
    std::vector<std::set<int> > exclusions;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
480
481
};

482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomNonbondedForceKernel();
    /**
     * 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);
    /**
498
     * Execute the kernel to calculate the forces and/or energy.
499
     *
500
501
502
503
     * @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
504
     */
505
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
506
private:
507
508
509
    int numParticles;
    int **exclusionArray;
    RealOpenMM **particleParamArray;
510
511
512
    RealOpenMM nonbondedCutoff, periodicBoxSize[3];
    std::vector<std::set<int> > exclusions;
    Lepton::ExpressionProgram energyExpression, forceExpression;
513
    std::vector<std::string> parameterNames, globalParameterNames;
514
515
516
517
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

518
/**
519
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
520
 */
521
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
522
public:
523
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
524
    }
525
    ~ReferenceCalcGBSAOBCForceKernel();
526
    /**
527
     * Initialize the kernel.
528
     * 
529
     * @param system     the System this kernel will be applied to
530
     * @param force      the GBSAOBCForce this kernel will be used for
531
     */
532
    void initialize(const System& system, const GBSAOBCForce& force);
533
    /**
534
535
536
537
538
539
     * 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
540
     */
541
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
542
543
544
private:
    CpuObc* obc;
    std::vector<RealOpenMM> charges;
545
    bool isPeriodic;
546
547
};

Mark Friedrichs's avatar
Mark Friedrichs committed
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
/**
 * This kernel is invoked by GBVIForce to calculate the forces acting on the system.
 */
class ReferenceCalcGBVIForceKernel : public CalcGBVIForceKernel {
public:
    ReferenceCalcGBVIForceKernel(std::string name, const Platform& platform) : CalcGBVIForceKernel(name, platform) {
    }
    ~ReferenceCalcGBVIForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system       the System this kernel will be applied to
     * @param force        the GBVIForce this kernel will be used for
     * @param scaled radii the scaled radii (Eq. 5 of Labute paper)
     */
    void initialize(const System& system, const GBVIForce& force, const std::vector<double> & scaledRadii);
    /**
565
566
567
568
569
570
     * 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
Mark Friedrichs's avatar
Mark Friedrichs committed
571
     */
572
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
Mark Friedrichs's avatar
Mark Friedrichs committed
573
574
575
private:
    CpuGBVI * gbvi;
    std::vector<RealOpenMM> charges;
576
    bool isPeriodic;
Mark Friedrichs's avatar
Mark Friedrichs committed
577
578
};

579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
/**
 * This kernel is invoked by CustomGBForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomGBForceKernel : public CalcCustomGBForceKernel {
public:
    ReferenceCalcCustomGBForceKernel(std::string name, const Platform& platform) : CalcCustomGBForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomGBForceKernel();
    /**
     * 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);
    /**
595
     * Execute the kernel to calculate the forces and/or energy.
596
     *
597
598
599
600
     * @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
601
     */
602
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
603
604
private:
    int numParticles;
605
    bool isPeriodic;
606
    RealOpenMM **particleParamArray;
607
    RealOpenMM nonbondedCutoff;
608
609
610
    std::vector<std::set<int> > exclusions;
    std::vector<std::string> particleParameterNames, globalParameterNames, valueNames;
    std::vector<Lepton::ExpressionProgram> valueExpressions;
611
    std::vector<std::vector<Lepton::ExpressionProgram> > valueDerivExpressions;
612
    std::vector<std::vector<Lepton::ExpressionProgram> > valueGradientExpressions;
613
614
615
    std::vector<OpenMM::CustomGBForce::ComputationType> valueTypes;
    std::vector<Lepton::ExpressionProgram> energyExpressions;
    std::vector<std::vector<Lepton::ExpressionProgram> > energyDerivExpressions;
616
    std::vector<std::vector<Lepton::ExpressionProgram> > energyGradientExpressions;
617
618
619
620
621
    std::vector<OpenMM::CustomGBForce::ComputationType> energyTypes;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
/**
 * This kernel is invoked by CustomExternalForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomExternalForceKernel : public CalcCustomExternalForceKernel {
public:
    ReferenceCalcCustomExternalForceKernel(std::string name, const Platform& platform) : CalcCustomExternalForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomExternalForceKernel();
    /**
     * 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);
    /**
638
     * Execute the kernel to calculate the forces and/or energy.
639
     *
640
641
642
643
     * @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
644
     */
645
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
646
647
648
649
650
651
652
653
private:
    int numParticles;
    std::vector<int> particles;
    RealOpenMM **particleParamArray;
    Lepton::ExpressionProgram energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
    std::vector<std::string> parameterNames, globalParameterNames;
};

654
655
656
657
658
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
659
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
660
661
662
663
664
665
666
667
668
669
    }
    ~ReferenceCalcCustomHbondForceKernel();
    /**
     * 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);
    /**
670
     * Execute the kernel to calculate the forces and/or energy.
671
     *
672
673
674
675
     * @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
676
     */
677
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
678
679
private:
    int numDonors, numAcceptors, numParticles;
680
    bool isPeriodic;
681
682
    int **exclusionArray;
    RealOpenMM **donorParamArray, **acceptorParamArray;
683
    RealOpenMM nonbondedCutoff;
684
    ReferenceCustomHbondIxn* ixn;
685
    std::vector<std::set<int> > exclusions;
686
    std::vector<std::string> globalParameterNames;
687
688
};

689
690
691
692
693
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class ReferenceIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
694
    ReferenceIntegrateVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVerletStepKernel(name, platform),
695
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
696
    }
697
    ~ReferenceIntegrateVerletStepKernel();
698
    /**
699
     * Initialize the kernel.
700
     * 
701
702
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
703
     */
704
    void initialize(const System& system, const VerletIntegrator& integrator);
705
706
707
    /**
     * Execute the kernel.
     * 
708
709
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
710
     */
711
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
712
private:
713
    ReferencePlatform::PlatformData& data;
714
    ReferenceVerletDynamics* dynamics;
715
    ReferenceConstraintAlgorithm* constraints;
716
    std::vector<RealOpenMM> masses;
717
    RealOpenMM* constraintDistances;
718
719
720
    int** constraintIndices;
    int numConstraints;
    double prevStepSize;
721
722
723
724
725
726
727
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class ReferenceIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
728
    ReferenceIntegrateLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinStepKernel(name, platform),
729
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
730
    }
731
    ~ReferenceIntegrateLangevinStepKernel();
732
    /**
Peter Eastman's avatar
Peter Eastman committed
733
     * Initialize the kernel, setting up the particle masses.
734
     * 
735
736
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
737
     */
738
    void initialize(const System& system, const LangevinIntegrator& integrator);
739
740
741
    /**
     * Execute the kernel.
     * 
742
743
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
744
     */
745
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
746
private:
747
    ReferencePlatform::PlatformData& data;
748
    ReferenceStochasticDynamics* dynamics;
749
    ReferenceConstraintAlgorithm* constraints;
750
    std::vector<RealOpenMM> masses;
751
    RealOpenMM* constraintDistances;
752
753
754
    int** constraintIndices;
    int numConstraints;
    double prevTemp, prevFriction, prevStepSize;
755
756
757
758
759
760
761
};

/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
762
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
763
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
764
    }
765
    ~ReferenceIntegrateBrownianStepKernel();
766
    /**
767
     * Initialize the kernel.
768
     * 
769
770
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
771
     */
772
    void initialize(const System& system, const BrownianIntegrator& integrator);
773
774
775
    /**
     * Execute the kernel.
     * 
776
777
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
778
     */
779
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
780
private:
781
    ReferencePlatform::PlatformData& data;
782
    ReferenceBrownianDynamics* dynamics;
783
    ReferenceConstraintAlgorithm* constraints;
784
    std::vector<RealOpenMM> masses;
785
    RealOpenMM* constraintDistances;
786
787
788
    int** constraintIndices;
    int numConstraints;
    double prevTemp, prevFriction, prevStepSize;
789
790
};

791
792
793
794
795
796
/**
 * This kernel is invoked by VariableLangevinIntegrator to take one time step.
 */
class ReferenceIntegrateVariableLangevinStepKernel : public IntegrateVariableLangevinStepKernel {
public:
    ReferenceIntegrateVariableLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVariableLangevinStepKernel(name, platform),
797
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
    }
    ~ReferenceIntegrateVariableLangevinStepKernel();
    /**
     * Initialize the kernel.
     *
     * @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 VariableLangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
     */
814
    void execute(ContextImpl& context, const VariableLangevinIntegrator& integrator, double maxTime);
815
816
817
818
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableStochasticDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
819
    std::vector<RealOpenMM> masses;
820
821
822
823
824
825
    RealOpenMM* constraintDistances;
    int** constraintIndices;
    int numConstraints;
    double prevTemp, prevFriction, prevErrorTol;
};

826
827
828
829
830
831
/**
 * This kernel is invoked by VariableVerletIntegrator to take one time step.
 */
class ReferenceIntegrateVariableVerletStepKernel : public IntegrateVariableVerletStepKernel {
public:
    ReferenceIntegrateVariableVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVariableVerletStepKernel(name, platform),
832
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
833
834
835
836
837
838
839
840
841
842
843
844
845
846
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * 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 VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
847
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
848
     */
849
    void execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
850
851
852
853
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
854
    std::vector<RealOpenMM> masses;
855
856
857
    RealOpenMM* constraintDistances;
    int** constraintIndices;
    int numConstraints;
858
    double prevErrorTol;
859
860
};

861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
/**
 * This kernel is invoked by CustomIntegrator to take one time step.
 */
class ReferenceIntegrateCustomStepKernel : public IntegrateCustomStepKernel {
public:
    ReferenceIntegrateCustomStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateCustomStepKernel(name, platform),
        data(data), dynamics(0), constraints(0), constraintDistances(0), constraintIndices(0) {
    }
    ~ReferenceIntegrateCustomStepKernel();
    /**
     * 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);
    /**
     * 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:
    ReferencePlatform::PlatformData& data;
    ReferenceCustomDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
    std::vector<RealOpenMM> masses, globalValues;
    std::vector<std::vector<OpenMM::RealVec> > perDofValues; 
    RealOpenMM* constraintDistances;
    int** constraintIndices;
    int numConstraints;
};

929
/**
Peter Eastman's avatar
Peter Eastman committed
930
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
931
932
933
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
934
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
935
    }
936
    ~ReferenceApplyAndersenThermostatKernel();
937
    /**
938
     * Initialize the kernel.
939
     * 
940
941
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
942
     */
943
    void initialize(const System& system, const AndersenThermostat& thermostat);
944
945
946
    /**
     * Execute the kernel.
     * 
947
     * @param context    the context in which to execute this kernel
948
     */
949
    void execute(ContextImpl& context);
950
951
private:
    ReferenceAndersenThermostat* thermostat;
952
    std::vector<std::vector<int> > particleGroups;
953
    std::vector<RealOpenMM> masses;
954
955
};

956
957
958
959
960
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
961
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
    void initialize(const System& system, const MonteCarloBarostat& barostat);
    /**
     * Attempt a Monte Carlo step, scaling particle positions (or cluster centers) by a specified value.
     * 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 scale      the scale factor by which to multiply particle positions
     */
    void scaleCoordinates(ContextImpl& context, double scale);
    /**
     * 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:
    ReferenceMonteCarloBarostat* barostat;
};

992
993
994
995
996
/**
 * This kernel is invoked to calculate the kinetic energy of the system.
 */
class ReferenceCalcKineticEnergyKernel : public CalcKineticEnergyKernel {
public:
997
    ReferenceCalcKineticEnergyKernel(std::string name, const Platform& platform) : CalcKineticEnergyKernel(name, platform) {
998
999
    }
    /**
1000
     * Initialize the kernel.
1001
     * 
1002
     * @param system     the System this kernel will be applied to
1003
     */
1004
    void initialize(const System& system);
1005
1006
1007
    /**
     * Execute the kernel.
     * 
1008
     * @param context    the context in which to execute this kernel
1009
     */
1010
    double execute(ContextImpl& context);
1011
1012
private:
    std::vector<double> masses;
1013
1014
};

1015
1016
1017
1018
1019
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1020
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1021
1022
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1023
     * Initialize the kernel, setting up the particle masses.
1024
     * 
1025
1026
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1027
     */
1028
    void initialize(const System& system, const CMMotionRemover& force);
1029
1030
1031
    /**
     * Execute the kernel.
     * 
1032
     * @param context    the context in which to execute this kernel
1033
     */
1034
    void execute(ContextImpl& context);
1035
private:
1036
    ReferencePlatform::PlatformData& data;
1037
    std::vector<double> masses;
1038
    int frequency;
1039
1040
};

1041
1042
1043
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/