ReferenceKernels.h 54.8 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-2016 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
38
#include "SimTKOpenMMRealType.h"
#include "ReferenceNeighborList.h"
39
#include "lepton/CompiledExpression.h"
40
#include "lepton/CustomFunction.h"
41

42
43
namespace OpenMM {

44
class ReferenceObc;
45
class ReferenceAndersenThermostat;
46
class ReferenceCustomCentroidBondIxn;
47
class ReferenceCustomCompoundBondIxn;
48
class ReferenceCustomHbondIxn;
49
class ReferenceCustomManyParticleIxn;
50
class ReferenceBrownianDynamics;
51
class ReferenceStochasticDynamics;
52
class ReferenceConstraintAlgorithm;
53
class ReferenceMonteCarloBarostat;
54
class ReferenceVariableStochasticDynamics;
55
class ReferenceVariableVerletDynamics;
56
class ReferenceVerletDynamics;
57
class ReferenceCustomDynamics;
58

59
/**
60
61
62
 * 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.
63
 */
64
class ReferenceCalcForcesAndEnergyKernel : public CalcForcesAndEnergyKernel {
65
public:
66
    ReferenceCalcForcesAndEnergyKernel(std::string name, const Platform& platform) : CalcForcesAndEnergyKernel(name, platform) {
67
68
69
70
71
72
73
74
    }
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
75
     * This is called at the beginning of each force/energy computation, before calcForcesAndEnergy() has been called on
76
77
     * any ForceImpl.
     *
78
79
80
     * @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
81
     * @param groups        a set of bit flags for which force groups to include
82
     */
83
    void beginComputation(ContextImpl& context, bool includeForce, bool includeEnergy, int groups);
84
    /**
85
     * This is called at the end of each force/energy computation, after calcForcesAndEnergy() has been called on
86
87
     * every ForceImpl.
     *
88
89
90
     * @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
91
     * @param groups        a set of bit flags for which force groups to include
92
93
     * @param valid         the method may set this to false to indicate the results are invalid and the force/energy
     *                      calculation should be repeated
94
     * @return the potential energy of the system.  This value is added to all values returned by ForceImpls'
95
     * calcForcesAndEnergy() methods.  That is, each force kernel may <i>either</i> return its contribution to the
96
     * energy directly, <i>or</i> add it to an internal buffer so that it will be included here.
97
     */
98
    double finishComputation(ContextImpl& context, bool includeForce, bool includeEnergy, int groups, bool& valid);
99
100
private:
    std::vector<RealVec> savedForces;
101
102
};

103
/**
104
105
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
106
 */
107
class ReferenceUpdateStateDataKernel : public UpdateStateDataKernel {
108
public:
109
    ReferenceUpdateStateDataKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : UpdateStateDataKernel(name, platform), data(data) {
110
111
112
113
114
115
116
117
118
119
120
121
    }
    /**
     * 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
     */
122
    double getTime(const ContextImpl& context) const;
123
124
125
126
127
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
128
    void setTime(ContextImpl& context, double time);
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    /**
     * 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);
159
160
161
162
163
164
    /**
     * Get the current derivatives of the energy with respect to context parameters.
     *
     * @param derivs  on exit, this contains the derivatives
     */
    void getEnergyParameterDerivatives(ContextImpl& context, std::map<std::string, double>& derivs);
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
    /**
     * 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
     */
180
    void setPeriodicBoxVectors(ContextImpl& context, const Vec3& a, const Vec3& b, const Vec3& c);
Peter Eastman's avatar
Peter Eastman committed
181
182
183
184
185
186
187
188
189
190
191
192
    /**
     * 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);
193
194
195
196
private:
    ReferencePlatform::PlatformData& data;
};

197
198
199
200
201
202
/**
 * 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) :
203
            ApplyConstraintsKernel(name, platform), data(data) {
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
    }
    ~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);
219
220
221
222
223
224
225
    /**
     * 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);
226
227
private:
    ReferencePlatform::PlatformData& data;
228
229
    std::vector<RealOpenMM> masses;
    std::vector<RealOpenMM> inverseMasses;
230
231
};

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/**
 * This kernel recomputes the positions of virtual sites.
 */
class ReferenceVirtualSitesKernel : public VirtualSitesKernel {
public:
    ReferenceVirtualSitesKernel(std::string name, const Platform& platform) : VirtualSitesKernel(name, platform) {
    }
    /**
     * 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);
};

253
/**
254
 * This kernel is invoked by HarmonicBondForce to calculate the forces acting on the system and the energy of the system.
255
 */
256
class ReferenceCalcHarmonicBondForceKernel : public CalcHarmonicBondForceKernel {
257
public:
258
    ReferenceCalcHarmonicBondForceKernel(std::string name, const Platform& platform) : CalcHarmonicBondForceKernel(name, platform) {
259
    }
260
    ~ReferenceCalcHarmonicBondForceKernel();
261
    /**
262
     * Initialize the kernel.
263
     * 
264
     * @param system     the System this kernel will be applied to
265
266
267
268
     * @param force      the HarmonicBondForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicBondForce& force);
    /**
269
270
271
272
273
274
     * 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
275
     */
276
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
277
278
279
280
281
282
283
    /**
     * 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);
284
285
286
287
private:
    int numBonds;
    int **bondIndexArray;
    RealOpenMM **bondParamArray;
288
    bool usePeriodic;
289
290
};

291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/**
 * 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);
    /**
307
     * Execute the kernel to calculate the forces and/or energy.
308
     *
309
310
311
312
     * @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
313
     */
314
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
315
316
317
318
319
320
321
    /**
     * 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);
322
323
324
325
private:
    int numBonds;
    int **bondIndexArray;
    RealOpenMM **bondParamArray;
326
    Lepton::CompiledExpression energyExpression, forceExpression;
327
328
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
329
    bool usePeriodic;
330
331
};

332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/**
 * 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);
    /**
348
349
350
351
352
353
     * 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
354
     */
355
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
356
357
358
359
360
361
362
    /**
     * 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);
363
364
365
366
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
367
    bool usePeriodic;
368
369
};

370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
/**
 * 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);
    /**
386
     * Execute the kernel to calculate the forces and/or energy.
387
     *
388
389
390
391
     * @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
392
     */
393
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
394
395
396
397
398
399
400
    /**
     * 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);
401
402
403
404
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
405
    Lepton::CompiledExpression energyExpression, forceExpression;
406
407
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
408
    bool usePeriodic;
409
410
};

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
/**
 * 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);
    /**
427
428
429
430
431
432
     * 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
433
     */
434
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
435
436
437
438
439
440
441
    /**
     * 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);
442
443
444
445
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
446
    bool usePeriodic;
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
};

/**
 * 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);
    /**
465
466
467
468
469
470
     * 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
471
     */
472
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
473
474
475
476
477
478
479
    /**
     * 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);
480
481
482
483
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
484
    bool usePeriodic;
485
486
};

487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/**
 * 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);
    /**
502
     * Execute the kernel to calculate the forces and/or energy.
503
     *
504
505
506
507
     * @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
508
     */
509
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
510
511
512
513
514
515
516
    /**
     * 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);
517
518
519
520
private:
    std::vector<std::vector<std::vector<RealOpenMM> > > coeff;
    std::vector<int> torsionMaps;
    std::vector<std::vector<int> > torsionIndices;
521
    bool usePeriodic;
522
523
};

524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
/**
 * 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);
    /**
540
     * Execute the kernel to calculate the forces and/or energy.
541
     *
542
543
544
545
     * @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
546
     */
547
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
548
549
550
551
552
553
554
    /**
     * 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);
555
556
557
558
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
559
    Lepton::CompiledExpression energyExpression, forceExpression;
560
561
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
562
    bool usePeriodic;
563
564
};

565
566
567
568
569
570
571
572
573
574
575
576
577
/**
 * 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
578
     */
579
    void initialize(const System& system, const NonbondedForce& force);
580
    /**
581
582
583
584
585
     * 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
586
     * @param includeReciprocal  true if reciprocal space interactions should be included
587
     * @return the potential energy due to the force
588
     */
589
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy, bool includeDirect, bool includeReciprocal);
590
591
592
593
594
595
596
    /**
     * 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);
597
598
599
600
601
602
603
604
605
    /**
     * 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;
606
private:
Peter Eastman's avatar
Peter Eastman committed
607
    int numParticles, num14;
608
    int **bonded14IndexArray;
Peter Eastman's avatar
Peter Eastman committed
609
    RealOpenMM **particleParamArray, **bonded14ParamArray;
610
    RealOpenMM nonbondedCutoff, switchingDistance, rfDielectric, ewaldAlpha, dispersionCoefficient;
611
    int kmax[3], gridSize[3];
612
    bool useSwitchingFunction;
613
614
615
    std::vector<std::set<int> > exclusions;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
616
617
};

618
619
620
621
622
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
623
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform), forceCopy(NULL) {
624
625
626
627
628
629
630
631
632
633
    }
    ~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);
    /**
634
     * Execute the kernel to calculate the forces and/or energy.
635
     *
636
637
638
639
     * @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
640
     */
641
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
642
643
644
645
646
647
648
    /**
     * 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);
649
private:
650
651
    int numParticles;
    RealOpenMM **particleParamArray;
652
653
    RealOpenMM nonbondedCutoff, switchingDistance, periodicBoxSize[3], longRangeCoefficient;
    bool useSwitchingFunction, hasInitializedLongRangeCorrection;
654
655
    CustomNonbondedForce* forceCopy;
    std::map<std::string, double> globalParamValues;
656
    std::vector<std::set<int> > exclusions;
657
    Lepton::CompiledExpression energyExpression, forceExpression;
658
659
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
660
    std::vector<std::pair<std::set<int>, std::set<int> > > interactionGroups;
661
    std::vector<double> longRangeCoefficientDerivs;
662
663
664
665
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

666
/**
667
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
668
 */
669
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
670
public:
671
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
672
    }
673
    ~ReferenceCalcGBSAOBCForceKernel();
674
    /**
675
     * Initialize the kernel.
676
     * 
677
     * @param system     the System this kernel will be applied to
678
     * @param force      the GBSAOBCForce this kernel will be used for
679
     */
680
    void initialize(const System& system, const GBSAOBCForce& force);
681
    /**
682
683
684
685
686
687
     * 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
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 GBSAOBCForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const GBSAOBCForce& force);
697
private:
698
    ReferenceObc* obc;
699
    std::vector<RealOpenMM> charges;
700
    bool isPeriodic;
701
702
};

703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
/**
 * 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);
    /**
719
     * Execute the kernel to calculate the forces and/or energy.
720
     *
721
722
723
724
     * @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
725
     */
726
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
727
728
729
730
731
732
733
    /**
     * 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);
734
735
private:
    int numParticles;
736
    bool isPeriodic;
737
    RealOpenMM **particleParamArray;
738
    RealOpenMM nonbondedCutoff;
739
    std::vector<std::set<int> > exclusions;
740
    std::vector<std::string> particleParameterNames, globalParameterNames, energyParamDerivNames, valueNames;
741
742
743
    std::vector<Lepton::CompiledExpression> valueExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueGradientExpressions;
744
    std::vector<std::vector<Lepton::CompiledExpression> > valueParamDerivExpressions;
745
    std::vector<OpenMM::CustomGBForce::ComputationType> valueTypes;
746
747
748
    std::vector<Lepton::CompiledExpression> energyExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyGradientExpressions;
749
    std::vector<std::vector<Lepton::CompiledExpression> > energyParamDerivExpressions;
750
751
752
753
754
    std::vector<OpenMM::CustomGBForce::ComputationType> energyTypes;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
/**
 * 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);
    /**
771
     * Execute the kernel to calculate the forces and/or energy.
772
     *
773
774
775
776
     * @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
777
     */
778
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
779
780
781
782
783
784
785
    /**
     * 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);
786
private:
787
    class PeriodicDistanceFunction;
788
789
790
    int numParticles;
    std::vector<int> particles;
    RealOpenMM **particleParamArray;
791
    Lepton::CompiledExpression energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
792
    std::vector<std::string> parameterNames, globalParameterNames;
793
794
795
796
797
798
799
800
801
802
803
    RealVec* boxVectors;
};

class ReferenceCalcCustomExternalForceKernel::PeriodicDistanceFunction : public Lepton::CustomFunction {
public:
    RealVec** boxVectorHandle;
    PeriodicDistanceFunction(RealVec** boxVectorHandle);
    int getNumArguments() const;
    double evaluate(const double* arguments) const;
    double evaluateDerivative(const double* arguments, const int* derivOrder) const;
    Lepton::CustomFunction* clone() const;
804
805
};

806
807
808
809
810
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
811
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
812
813
814
815
816
817
818
819
820
821
    }
    ~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);
    /**
822
     * Execute the kernel to calculate the forces and/or energy.
823
     *
824
825
826
827
     * @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
828
     */
829
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
830
831
832
833
834
835
836
    /**
     * 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);
837
838
private:
    int numDonors, numAcceptors, numParticles;
839
    bool isPeriodic;
840
    RealOpenMM **donorParamArray, **acceptorParamArray;
841
    RealOpenMM nonbondedCutoff;
842
    ReferenceCustomHbondIxn* ixn;
843
    std::vector<std::set<int> > exclusions;
844
    std::vector<std::string> globalParameterNames;
845
846
};

847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
/**
 * This kernel is invoked by CustomCentroidBondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomCentroidBondForceKernel : public CalcCustomCentroidBondForceKernel {
public:
    ReferenceCalcCustomCentroidBondForceKernel(std::string name, const Platform& platform) : CalcCustomCentroidBondForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomCentroidBondForceKernel();
    /**
     * 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 numBonds, numParticles;
    RealOpenMM **bondParamArray;
    ReferenceCustomCentroidBondIxn* ixn;
882
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
883
    bool usePeriodic;
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
/**
 * This kernel is invoked by CustomCompoundBondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomCompoundBondForceKernel : public CalcCustomCompoundBondForceKernel {
public:
    ReferenceCalcCustomCompoundBondForceKernel(std::string name, const Platform& platform) : CalcCustomCompoundBondForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomCompoundBondForceKernel();
    /**
     * 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);
910
911
912
913
914
915
916
    /**
     * 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);
917
private:
918
    int numBonds;
919
920
    RealOpenMM **bondParamArray;
    ReferenceCustomCompoundBondIxn* ixn;
921
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
922
    bool usePeriodic;
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
/**
 * This kernel is invoked by CustomManyParticleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomManyParticleForceKernel : public CalcCustomManyParticleForceKernel {
public:
    ReferenceCalcCustomManyParticleForceKernel(std::string name, const Platform& platform) : CalcCustomManyParticleForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomManyParticleForceKernel();
    /**
     * 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:
    int numParticles;
    RealOpenMM cutoffDistance;
    RealOpenMM **particleParamArray;
    ReferenceCustomManyParticleIxn* ixn;
    std::vector<std::string> globalParameterNames;
    NonbondedMethod nonbondedMethod;
};

965
966
967
968
969
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class ReferenceIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
970
    ReferenceIntegrateVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVerletStepKernel(name, platform),
971
        data(data), dynamics(0) {
972
    }
973
    ~ReferenceIntegrateVerletStepKernel();
974
    /**
975
     * Initialize the kernel.
976
     * 
977
978
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
979
     */
980
    void initialize(const System& system, const VerletIntegrator& integrator);
981
982
983
    /**
     * Execute the kernel.
     * 
984
985
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
986
     */
987
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
988
989
990
991
992
993
994
    /**
     * 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);
995
private:
996
    ReferencePlatform::PlatformData& data;
997
    ReferenceVerletDynamics* dynamics;
998
    std::vector<RealOpenMM> masses;
999
    double prevStepSize;
1000
1001
1002
1003
1004
1005
1006
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class ReferenceIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
1007
    ReferenceIntegrateLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinStepKernel(name, platform),
1008
        data(data), dynamics(0) {
1009
    }
1010
    ~ReferenceIntegrateLangevinStepKernel();
1011
    /**
Peter Eastman's avatar
Peter Eastman committed
1012
     * Initialize the kernel, setting up the particle masses.
1013
     * 
1014
1015
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
1016
     */
1017
    void initialize(const System& system, const LangevinIntegrator& integrator);
1018
1019
1020
    /**
     * Execute the kernel.
     * 
1021
1022
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
1023
     */
1024
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
1025
1026
1027
1028
1029
1030
1031
    /**
     * 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);
1032
private:
1033
    ReferencePlatform::PlatformData& data;
1034
    ReferenceStochasticDynamics* dynamics;
1035
    std::vector<RealOpenMM> masses;
1036
    double prevTemp, prevFriction, prevStepSize;
1037
1038
1039
1040
1041
1042
1043
};

/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
1044
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
1045
        data(data), dynamics(0) {
1046
    }
1047
    ~ReferenceIntegrateBrownianStepKernel();
1048
    /**
1049
     * Initialize the kernel.
1050
     * 
1051
1052
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
1053
     */
1054
    void initialize(const System& system, const BrownianIntegrator& integrator);
1055
1056
1057
    /**
     * Execute the kernel.
     * 
1058
1059
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
1060
     */
1061
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
1062
1063
1064
1065
1066
1067
1068
    /**
     * 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);
1069
private:
1070
    ReferencePlatform::PlatformData& data;
1071
    ReferenceBrownianDynamics* dynamics;
1072
    std::vector<RealOpenMM> masses;
1073
    double prevTemp, prevFriction, prevStepSize;
1074
1075
};

1076
1077
1078
1079
1080
1081
/**
 * 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),
1082
        data(data), dynamics(0) {
1083
1084
1085
1086
1087
1088
    }
    ~ReferenceIntegrateVariableLangevinStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1089
     * @param integrator the VariableLangevinIntegrator this kernel will be used for
1090
1091
1092
1093
1094
1095
     */
    void initialize(const System& system, const VariableLangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1096
     * @param integrator the VariableLangevinIntegrator this kernel is being used for
1097
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1098
     * @return the size of the step that was taken
1099
     */
1100
    double execute(ContextImpl& context, const VariableLangevinIntegrator& integrator, double maxTime);
1101
1102
1103
1104
1105
1106
1107
    /**
     * 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);
1108
1109
1110
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableStochasticDynamics* dynamics;
1111
    std::vector<RealOpenMM> masses;
1112
1113
1114
    double prevTemp, prevFriction, prevErrorTol;
};

1115
1116
1117
1118
1119
1120
/**
 * 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),
1121
        data(data), dynamics(0) {
1122
1123
1124
1125
1126
1127
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1128
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1129
1130
1131
1132
1133
1134
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1135
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1136
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1137
     * @return the size of the step that was taken
1138
     */
1139
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1140
1141
1142
1143
1144
1145
1146
    /**
     * 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);
1147
1148
1149
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
1150
    std::vector<RealOpenMM> masses;
1151
    double prevErrorTol;
1152
1153
};

1154
1155
1156
1157
1158
1159
/**
 * 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),
1160
        data(data), dynamics(0) {
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
    }
    ~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);
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
    /**
     * 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);
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
    /**
     * 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;
    std::vector<RealOpenMM> masses, globalValues;
    std::vector<std::vector<OpenMM::RealVec> > perDofValues; 
};

1229
/**
Peter Eastman's avatar
Peter Eastman committed
1230
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
1231
1232
1233
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
1234
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
1235
    }
1236
    ~ReferenceApplyAndersenThermostatKernel();
1237
    /**
1238
     * Initialize the kernel.
1239
     * 
1240
1241
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
1242
     */
1243
    void initialize(const System& system, const AndersenThermostat& thermostat);
1244
1245
1246
    /**
     * Execute the kernel.
     * 
1247
     * @param context    the context in which to execute this kernel
1248
     */
1249
    void execute(ContextImpl& context);
1250
1251
private:
    ReferenceAndersenThermostat* thermostat;
1252
    std::vector<std::vector<int> > particleGroups;
1253
    std::vector<RealOpenMM> masses;
1254
1255
};

1256
1257
1258
1259
1260
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
1261
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
1262
1263
1264
1265
1266
1267
1268
1269
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
1270
    void initialize(const System& system, const Force& barostat);
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
    /**
     * 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
     */
1283
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
    /**
     * 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;
};

1295
1296
1297
1298
1299
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1300
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1301
1302
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1303
     * Initialize the kernel, setting up the particle masses.
1304
     * 
1305
1306
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1307
     */
1308
    void initialize(const System& system, const CMMotionRemover& force);
1309
1310
1311
    /**
     * Execute the kernel.
     * 
1312
     * @param context    the context in which to execute this kernel
1313
     */
1314
    void execute(ContextImpl& context);
1315
private:
1316
    ReferencePlatform::PlatformData& data;
1317
    std::vector<double> masses;
1318
    int frequency;
1319
1320
};

1321
1322
1323
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/