ReferenceKernels.h 56 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 ReferenceGayBerneForce;
51
class ReferenceBrownianDynamics;
52
class ReferenceStochasticDynamics;
53
class ReferenceConstraintAlgorithm;
54
class ReferenceMonteCarloBarostat;
55
class ReferenceVariableStochasticDynamics;
56
class ReferenceVariableVerletDynamics;
57
class ReferenceVerletDynamics;
58
class ReferenceCustomDynamics;
59

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

104
/**
105
106
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
107
 */
108
class ReferenceUpdateStateDataKernel : public UpdateStateDataKernel {
109
public:
110
    ReferenceUpdateStateDataKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : UpdateStateDataKernel(name, platform), data(data) {
111
112
113
114
115
116
117
118
119
120
121
122
    }
    /**
     * 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
     */
123
    double getTime(const ContextImpl& context) const;
124
125
126
127
128
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
129
    void setTime(ContextImpl& context, double time);
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
159
    /**
     * 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);
160
161
162
163
164
165
    /**
     * 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);
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
    /**
     * 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
     */
181
    void setPeriodicBoxVectors(ContextImpl& context, const Vec3& a, const Vec3& b, const Vec3& c);
Peter Eastman's avatar
Peter Eastman committed
182
183
184
185
186
187
188
189
190
191
192
193
    /**
     * 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);
194
195
196
197
private:
    ReferencePlatform::PlatformData& data;
};

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

233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/**
 * 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);
};

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

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

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

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

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

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

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

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

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

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

667
/**
668
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
669
 */
670
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
671
public:
672
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
673
    }
674
    ~ReferenceCalcGBSAOBCForceKernel();
675
    /**
676
     * Initialize the kernel.
677
     * 
678
     * @param system     the System this kernel will be applied to
679
     * @param force      the GBSAOBCForce this kernel will be used for
680
     */
681
    void initialize(const System& system, const GBSAOBCForce& force);
682
    /**
683
684
685
686
687
688
     * 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
689
     */
690
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
691
692
693
694
695
696
697
    /**
     * 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);
698
private:
699
    ReferenceObc* obc;
peastman's avatar
peastman committed
700
    std::vector<double> charges;
701
    bool isPeriodic;
702
703
};

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

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

class ReferenceCalcCustomExternalForceKernel::PeriodicDistanceFunction : public Lepton::CustomFunction {
public:
peastman's avatar
peastman committed
799
800
    Vec3** boxVectorHandle;
    PeriodicDistanceFunction(Vec3** boxVectorHandle);
801
802
803
804
    int getNumArguments() const;
    double evaluate(const double* arguments) const;
    double evaluateDerivative(const double* arguments, const int* derivOrder) const;
    Lepton::CustomFunction* clone() const;
805
806
};

807
808
809
810
811
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
812
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
813
814
815
816
817
818
819
820
821
822
    }
    ~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);
    /**
823
     * Execute the kernel to calculate the forces and/or energy.
824
     *
825
826
827
828
     * @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
829
     */
830
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
831
832
833
834
835
836
837
    /**
     * 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);
838
839
private:
    int numDonors, numAcceptors, numParticles;
840
    bool isPeriodic;
peastman's avatar
peastman committed
841
842
    double **donorParamArray, **acceptorParamArray;
    double nonbondedCutoff;
843
    ReferenceCustomHbondIxn* ixn;
844
    std::vector<std::set<int> > exclusions;
845
    std::vector<std::string> globalParameterNames;
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
/**
 * 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;
peastman's avatar
peastman committed
881
    double **bondParamArray;
882
    ReferenceCustomCentroidBondIxn* ixn;
883
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
884
    bool usePeriodic;
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
/**
 * 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);
911
912
913
914
915
916
917
    /**
     * 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);
918
private:
919
    int numBonds;
peastman's avatar
peastman committed
920
    double **bondParamArray;
921
    ReferenceCustomCompoundBondIxn* ixn;
922
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
923
    bool usePeriodic;
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
/**
 * 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;
peastman's avatar
peastman committed
959
960
    double cutoffDistance;
    double **particleParamArray;
961
962
963
964
965
    ReferenceCustomManyParticleIxn* ixn;
    std::vector<std::string> globalParameterNames;
    NonbondedMethod nonbondedMethod;
};

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
992
993
994
995
996
997
998
999
/**
 * This kernel is invoked by GayBerneForce to calculate the forces acting on the system.
 */
class ReferenceCalcGayBerneForceKernel : public CalcGayBerneForceKernel {
public:
    ReferenceCalcGayBerneForceKernel(std::string name, const Platform& platform) : CalcGayBerneForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcGayBerneForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the GayBerneForce this kernel will be used for
     */
    void initialize(const System& system, const GayBerneForce& 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
     * @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 GayBerneForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const GayBerneForce& force);
private:
    ReferenceGayBerneForce* ixn;
};

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

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

/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
1079
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
1080
        data(data), dynamics(0) {
1081
    }
1082
    ~ReferenceIntegrateBrownianStepKernel();
1083
    /**
1084
     * Initialize the kernel.
1085
     * 
1086
1087
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
1088
     */
1089
    void initialize(const System& system, const BrownianIntegrator& integrator);
1090
1091
1092
    /**
     * Execute the kernel.
     * 
1093
1094
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
1095
     */
1096
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
1097
1098
1099
1100
1101
1102
1103
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
     */
    double computeKineticEnergy(ContextImpl& context, const BrownianIntegrator& integrator);
1104
private:
1105
    ReferencePlatform::PlatformData& data;
1106
    ReferenceBrownianDynamics* dynamics;
peastman's avatar
peastman committed
1107
    std::vector<double> masses;
1108
    double prevTemp, prevFriction, prevStepSize;
1109
1110
};

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

1150
1151
1152
1153
1154
1155
/**
 * 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),
1156
        data(data), dynamics(0) {
1157
1158
1159
1160
1161
1162
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1163
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1164
1165
1166
1167
1168
1169
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1170
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1171
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1172
     * @return the size of the step that was taken
1173
     */
1174
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1175
1176
1177
1178
1179
1180
1181
    /**
     * 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);
1182
1183
1184
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
peastman's avatar
peastman committed
1185
    std::vector<double> masses;
1186
    double prevErrorTol;
1187
1188
};

1189
1190
1191
1192
1193
1194
/**
 * 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),
1195
        data(data), dynamics(0) {
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
    }
    ~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);
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
    /**
     * 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);
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
    /**
     * 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;
peastman's avatar
peastman committed
1260
1261
    std::vector<double> masses, globalValues;
    std::vector<std::vector<OpenMM::Vec3> > perDofValues; 
1262
1263
};

1264
/**
Peter Eastman's avatar
Peter Eastman committed
1265
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
1266
1267
1268
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
1269
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
1270
    }
1271
    ~ReferenceApplyAndersenThermostatKernel();
1272
    /**
1273
     * Initialize the kernel.
1274
     * 
1275
1276
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
1277
     */
1278
    void initialize(const System& system, const AndersenThermostat& thermostat);
1279
1280
1281
    /**
     * Execute the kernel.
     * 
1282
     * @param context    the context in which to execute this kernel
1283
     */
1284
    void execute(ContextImpl& context);
1285
1286
private:
    ReferenceAndersenThermostat* thermostat;
1287
    std::vector<std::vector<int> > particleGroups;
peastman's avatar
peastman committed
1288
    std::vector<double> masses;
1289
1290
};

1291
1292
1293
1294
1295
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
1296
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
1297
1298
1299
1300
1301
1302
1303
1304
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
1305
    void initialize(const System& system, const Force& barostat);
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
    /**
     * 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
     */
1318
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
    /**
     * 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;
};

1330
1331
1332
1333
1334
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1335
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1336
1337
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1338
     * Initialize the kernel, setting up the particle masses.
1339
     * 
1340
1341
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1342
     */
1343
    void initialize(const System& system, const CMMotionRemover& force);
1344
1345
1346
    /**
     * Execute the kernel.
     * 
1347
     * @param context    the context in which to execute this kernel
1348
     */
1349
    void execute(ContextImpl& context);
1350
private:
1351
    ReferencePlatform::PlatformData& data;
1352
    std::vector<double> masses;
1353
    int frequency;
1354
1355
};

1356
1357
1358
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/