ReferenceKernels.h 67.1 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-2021 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
#include <array>
#include <utility>
43

44
45
namespace OpenMM {

46
class ReferenceObc;
47
class ReferenceAndersenThermostat;
48
class ReferenceLangevinMiddleDynamics;
49
50
51
52
class ReferenceCustomBondIxn;
class ReferenceCustomAngleIxn;
class ReferenceCustomTorsionIxn;
class ReferenceCustomExternalIxn;
53
class ReferenceCustomCentroidBondIxn;
54
class ReferenceCustomCompoundBondIxn;
55
class ReferenceCustomCVForce;
56
class ReferenceCustomHbondIxn;
57
class ReferenceCustomManyParticleIxn;
58
class ReferenceGayBerneForce;
59
class ReferenceBrownianDynamics;
60
class ReferenceStochasticDynamics;
61
class ReferenceConstraintAlgorithm;
62
class ReferenceNoseHooverChain;
63
class ReferenceMonteCarloBarostat;
64
class ReferenceNoseHooverDynamics;
65
class ReferenceVariableStochasticDynamics;
66
class ReferenceVariableVerletDynamics;
67
class ReferenceVerletDynamics;
68
class ReferenceCustomDynamics;
69

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

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

208
209
210
211
212
213
/**
 * 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) :
214
            ApplyConstraintsKernel(name, platform), data(data) {
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    }
    ~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);
230
231
232
233
234
235
236
    /**
     * 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);
237
238
private:
    ReferencePlatform::PlatformData& data;
peastman's avatar
peastman committed
239
240
    std::vector<double> masses;
    std::vector<double> inverseMasses;
241
242
};

243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/**
 * 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);
};

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

301
302
303
304
305
/**
 * 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:
306
    ReferenceCalcCustomBondForceKernel(std::string name, const Platform& platform) : CalcCustomBondForceKernel(name, platform), ixn(NULL) {
307
    }
308
    ~ReferenceCalcCustomBondForceKernel();
309
310
311
312
313
314
315
316
    /**
     * 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);
    /**
317
     * Execute the kernel to calculate the forces and/or energy.
318
     *
319
320
321
322
     * @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
323
     */
324
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
325
326
327
328
329
330
331
    /**
     * 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);
332
333
private:
    int numBonds;
334
    ReferenceCustomBondIxn* ixn;
335
336
    std::vector<std::vector<int> >bondIndexArray;
    std::vector<std::vector<double> >bondParamArray;
337
    Lepton::CompiledExpression energyExpression, forceExpression;
338
339
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
340
    bool usePeriodic;
341
342
};

343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/**
 * 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) {
    }
    /**
     * 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);
    /**
358
359
360
361
362
363
     * 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
364
     */
365
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
366
367
368
369
370
371
372
    /**
     * 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);
373
374
private:
    int numAngles;
375
376
    std::vector<std::vector<int> >angleIndexArray;
    std::vector<std::vector<double> >angleParamArray;
377
    bool usePeriodic;
378
379
};

380
381
382
383
384
/**
 * 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:
385
    ReferenceCalcCustomAngleForceKernel(std::string name, const Platform& platform) : CalcCustomAngleForceKernel(name, platform), ixn(NULL) {
386
    }
387
    ~ReferenceCalcCustomAngleForceKernel();
388
389
390
391
392
393
394
395
    /**
     * 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);
    /**
396
     * Execute the kernel to calculate the forces and/or energy.
397
     *
398
399
400
401
     * @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
402
     */
403
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
404
405
406
407
408
409
410
    /**
     * 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);
411
412
private:
    int numAngles;
413
    ReferenceCustomAngleIxn* ixn;
414
415
    std::vector<std::vector<int> >angleIndexArray;
    std::vector<std::vector<double> >angleParamArray;
416
    Lepton::CompiledExpression energyExpression, forceExpression;
417
418
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
419
    bool usePeriodic;
420
421
};

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
/**
 * 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) {
    }
    /**
     * 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);
    /**
437
438
439
440
441
442
     * 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
443
     */
444
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
445
446
447
448
449
450
451
    /**
     * 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);
452
453
private:
    int numTorsions;
454
455
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
456
    bool usePeriodic;
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
};

/**
 * 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) {
    }
    /**
     * 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);
    /**
474
475
476
477
478
479
     * 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
480
     */
481
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
482
483
484
485
486
487
488
    /**
     * 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);
489
490
private:
    int numTorsions;
491
492
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
493
    bool usePeriodic;
494
495
};

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

533
534
535
536
537
/**
 * 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:
538
    ReferenceCalcCustomTorsionForceKernel(std::string name, const Platform& platform) : CalcCustomTorsionForceKernel(name, platform), ixn(NULL) {
539
    }
540
    ~ReferenceCalcCustomTorsionForceKernel();
541
542
543
544
545
546
547
548
    /**
     * 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);
    /**
549
     * Execute the kernel to calculate the forces and/or energy.
550
     *
551
552
553
554
     * @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
555
     */
556
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
557
558
559
560
561
562
563
    /**
     * 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);
564
565
private:
    int numTorsions;
566
    ReferenceCustomTorsionIxn* ixn;
567
568
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
569
    Lepton::CompiledExpression energyExpression, forceExpression;
570
571
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
572
    bool usePeriodic;
573
574
};

575
576
577
578
579
580
581
582
583
584
585
586
587
/**
 * 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
588
     */
589
    void initialize(const System& system, const NonbondedForce& force);
590
    /**
591
592
593
594
595
     * 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
596
     * @param includeReciprocal  true if reciprocal space interactions should be included
597
     * @return the potential energy due to the force
598
     */
599
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy, bool includeDirect, bool includeReciprocal);
600
601
602
603
604
605
606
    /**
     * 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);
607
608
609
610
611
612
613
614
615
    /**
     * 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;
616
617
618
    /**
     * Get the dispersion parameters being used for the dispersion term in LJPME.
     *
619
620
621
622
     * @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
623
     */
624
    void getLJPMEParameters(double& alpha, int& nx, int& ny, int& nz) const;
625
private:
626
    void computeParameters(ContextImpl& context);
Peter Eastman's avatar
Peter Eastman committed
627
    int numParticles, num14;
628
629
    std::vector<std::vector<int> >bonded14IndexArray;
    std::vector<std::vector<double> > particleParamArray, bonded14ParamArray;
630
631
    std::vector<std::array<double, 3> > baseParticleParams, baseExceptionParams;
    std::map<std::pair<std::string, int>, std::array<double, 3> > particleParamOffsets, exceptionParamOffsets;
peastman's avatar
peastman committed
632
    double nonbondedCutoff, switchingDistance, rfDielectric, ewaldAlpha, ewaldDispersionAlpha, dispersionCoefficient;
633
    int kmax[3], gridSize[3], dispersionGridSize[3];
634
    bool useSwitchingFunction, exceptionsArePeriodic;
635
636
637
    std::vector<std::set<int> > exclusions;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
638
639
};

640
641
642
643
644
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
645
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform), forceCopy(NULL) {
646
647
648
649
650
651
652
653
654
655
    }
    ~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);
    /**
656
     * Execute the kernel to calculate the forces and/or energy.
657
     *
658
659
660
661
     * @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
662
     */
663
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
664
665
666
667
668
669
670
    /**
     * 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);
671
private:
672
    int numParticles;
673
    std::vector<std::vector<double> > particleParamArray;
peastman's avatar
peastman committed
674
    double nonbondedCutoff, switchingDistance, periodicBoxSize[3], longRangeCoefficient;
675
    bool useSwitchingFunction, hasInitializedLongRangeCorrection;
676
677
    CustomNonbondedForce* forceCopy;
    std::map<std::string, double> globalParamValues;
678
    std::vector<std::set<int> > exclusions;
679
    Lepton::CompiledExpression energyExpression, forceExpression;
680
681
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
682
    std::vector<std::pair<std::set<int>, std::set<int> > > interactionGroups;
683
    std::vector<double> longRangeCoefficientDerivs;
684
685
686
687
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

688
/**
689
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
690
 */
691
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
692
public:
693
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
694
    }
695
    ~ReferenceCalcGBSAOBCForceKernel();
696
    /**
697
     * Initialize the kernel.
698
     * 
699
     * @param system     the System this kernel will be applied to
700
     * @param force      the GBSAOBCForce this kernel will be used for
701
     */
702
    void initialize(const System& system, const GBSAOBCForce& force);
703
    /**
704
705
706
707
708
709
     * 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
710
     */
711
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
712
713
714
715
716
717
718
    /**
     * 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);
719
private:
720
    ReferenceObc* obc;
peastman's avatar
peastman committed
721
    std::vector<double> charges;
722
    bool isPeriodic;
723
724
};

725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
/**
 * 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);
    /**
741
     * Execute the kernel to calculate the forces and/or energy.
742
     *
743
744
745
746
     * @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
747
     */
748
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
749
750
751
752
753
754
755
    /**
     * 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);
756
757
private:
    int numParticles;
758
    bool isPeriodic;
759
    std::vector<std::vector<double> > particleParamArray;
peastman's avatar
peastman committed
760
    double nonbondedCutoff;
761
    std::vector<std::set<int> > exclusions;
762
    std::vector<std::string> particleParameterNames, globalParameterNames, energyParamDerivNames, valueNames;
763
764
765
    std::vector<Lepton::CompiledExpression> valueExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueGradientExpressions;
766
    std::vector<std::vector<Lepton::CompiledExpression> > valueParamDerivExpressions;
767
    std::vector<OpenMM::CustomGBForce::ComputationType> valueTypes;
768
769
770
    std::vector<Lepton::CompiledExpression> energyExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyGradientExpressions;
771
    std::vector<std::vector<Lepton::CompiledExpression> > energyParamDerivExpressions;
772
773
774
775
776
    std::vector<OpenMM::CustomGBForce::ComputationType> energyTypes;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

777
778
779
780
781
/**
 * 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:
782
    ReferenceCalcCustomExternalForceKernel(std::string name, const Platform& platform) : CalcCustomExternalForceKernel(name, platform), ixn(NULL) {
783
    }
784
    ~ReferenceCalcCustomExternalForceKernel();
785
786
787
788
789
790
791
792
    /**
     * 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);
    /**
793
     * Execute the kernel to calculate the forces and/or energy.
794
     *
795
796
797
798
     * @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
799
     */
800
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
801
802
803
804
805
806
807
    /**
     * 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);
808
809
private:
    int numParticles;
810
    ReferenceCustomExternalIxn* ixn;
811
    std::vector<int> particles;
812
    std::vector<std::vector<double> > particleParamArray;
813
    Lepton::CompiledExpression energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
814
    std::vector<std::string> parameterNames, globalParameterNames;
peastman's avatar
peastman committed
815
    Vec3* boxVectors;
816
817
};

818
819
820
821
822
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
823
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
824
825
826
827
828
829
830
831
832
833
    }
    ~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);
    /**
834
     * Execute the kernel to calculate the forces and/or energy.
835
     *
836
837
838
839
     * @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
840
     */
841
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
842
843
844
845
846
847
848
    /**
     * 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);
849
850
private:
    int numDonors, numAcceptors, numParticles;
851
    bool isPeriodic;
852
    std::vector<std::vector<double> > donorParamArray, acceptorParamArray;
peastman's avatar
peastman committed
853
    double nonbondedCutoff;
854
    ReferenceCustomHbondIxn* ixn;
855
    std::vector<std::set<int> > exclusions;
856
    std::vector<std::string> globalParameterNames;
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
882
883
884
885
886
887
888
889
890
891
/**
 * 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;
892
    std::vector<std::vector<double> > bondParamArray;
893
    ReferenceCustomCentroidBondIxn* ixn;
894
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
895
    bool usePeriodic;
896
    Vec3* boxVectors;
897
898
};

899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
/**
 * 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);
923
924
925
926
927
928
929
    /**
     * 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);
930
private:
931
    int numBonds;
932
    std::vector<std::vector<double> > bondParamArray;
933
    ReferenceCustomCompoundBondIxn* ixn;
934
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
935
    bool usePeriodic;
936
    Vec3* boxVectors;
937
938
};

939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
/**
 * 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
972
    double cutoffDistance;
973
    std::vector<std::vector<double> > particleParamArray;
974
975
976
977
978
    ReferenceCustomManyParticleIxn* ixn;
    std::vector<std::string> globalParameterNames;
    NonbondedMethod nonbondedMethod;
};

979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
/**
 * 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;
};

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
/**
 * This kernel is invoked by CustomCVForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomCVForceKernel : public CalcCustomCVForceKernel {
public:
    ReferenceCalcCustomCVForceKernel(std::string name, const Platform& platform) : CalcCustomCVForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomCVForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomCVForce this kernel will be used for
1026
     * @param innerContext   the context created by the CustomCVForce for computing collective variables
1027
     */
1028
    void initialize(const System& system, const CustomCVForce& force, ContextImpl& innerContext);
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param innerContext   the context created by the CustomCVForce for computing collective variables
     * @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, ContextImpl& innerContext, bool includeForces, bool includeEnergy);
    /**
     * Copy state information to the inner context.
     *
     * @param context        the context in which to execute this kernel
     * @param innerContext   the context created by the CustomCVForce for computing collective variables
     */
    void copyState(ContextImpl& context, ContextImpl& innerContext);
1046
1047
1048
1049
1050
1051
1052
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomCVForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomCVForce& force);
1053
1054
1055
1056
1057
private:
    ReferenceCustomCVForce* ixn;
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
};

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
/**
 * This kernel is invoked by RMSDForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcRMSDForceKernel : public CalcRMSDForceKernel {
public:
    ReferenceCalcRMSDForceKernel(std::string name, const Platform& platform) : CalcRMSDForceKernel(name, platform) {
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the RMSDForce this kernel will be used for
     */
    void initialize(const System& system, const RMSDForce& 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 RMSDForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const RMSDForce& force);
private:
    std::vector<Vec3> referencePos;
    std::vector<int> particles;
};

1093
1094
1095
1096
1097
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class ReferenceIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
1098
    ReferenceIntegrateVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVerletStepKernel(name, platform),
1099
        data(data), dynamics(0) {
1100
    }
1101
    ~ReferenceIntegrateVerletStepKernel();
1102
    /**
1103
     * Initialize the kernel.
1104
     * 
1105
1106
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
1107
     */
1108
    void initialize(const System& system, const VerletIntegrator& integrator);
1109
1110
1111
    /**
     * Execute the kernel.
     * 
1112
1113
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
1114
     */
1115
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
1116
1117
1118
1119
1120
1121
1122
    /**
     * 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);
1123
private:
1124
    ReferencePlatform::PlatformData& data;
1125
    ReferenceVerletDynamics* dynamics;
peastman's avatar
peastman committed
1126
    std::vector<double> masses;
1127
    double prevStepSize;
1128
1129
1130
}
;
/**
1131
 * This kernel is invoked by NoseHooverIntegrator to take one time step.
1132
 */
1133
class ReferenceIntegrateNoseHooverStepKernel : public IntegrateNoseHooverStepKernel {
1134
public:
1135
    ReferenceIntegrateNoseHooverStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateNoseHooverStepKernel(name, platform),
1136
1137
        data(data), dynamics(0) {
    }
1138
    ~ReferenceIntegrateNoseHooverStepKernel();
1139
1140
1141
1142
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
1143
     * @param integrator the NoseHooverIntegrator this kernel will be used for
1144
     */
1145
    void initialize(const System& system, const NoseHooverIntegrator& integrator);
1146
1147
1148
1149
1150
    /**
     * Execute the kernel.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
1151
1152
     * @param forcesAreValid a reference to the parent integrator's boolean for keeping
     *                       track of the validity of the current forces.
1153
     */
1154
    void execute(ContextImpl& context, const NoseHooverIntegrator& integrator, bool &forcesAreValid);
1155
1156
1157
1158
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
1159
     * @param integrator the NoseHooverIntegrator this kernel is being used for
1160
     */
1161
    double computeKineticEnergy(ContextImpl& context, const NoseHooverIntegrator& integrator);
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
    /**
     * Execute the kernel that propagates the Nose Hoover chain and determines the velocity scale factor.
     * 
     * @param context  the context in which to execute this kernel
     * @param noseHooverChain the object describing the chain to be propagated.
     * @param kineticEnergy the {center of mass, relative} kineticEnergies of the particles being thermostated by this chain.
     * @param timeStep the time step used by the integrator.
     * @return the velocity scale factor to apply to the particles associated with this heat bath.
     */
    std::pair<double, double> propagateChain(ContextImpl& context, const NoseHooverChain &noseHooverChain, std::pair<double, double> kineticEnergy, double timeStep);
    /**
     * Execute the kernal that computes the total (kinetic + potential) heat bath energy.
     *
     * @param context the context in which to execute this kernel
     * @param noseHooverChain the chain whose energy is to be determined.
     * @return the total heat bath energy.
     */
    double computeHeatBathEnergy(ContextImpl& context, const NoseHooverChain &noseHooverChain);
    /**
     * Execute the kernel that computes the kinetic energy for a subset of atoms,
     * or the relative kinetic energy of Drude particles with respect to their parent atoms
     *
     * @param context the context in which to execute this kernel
     * @param noseHooverChain the chain whose energy is to be determined.
     * @param downloadValue whether the computed value should be downloaded and returned.
     */
    std::pair<double, double> computeMaskedKineticEnergy(ContextImpl& context, const NoseHooverChain &noseHooverChain, bool downloadValue);
    /**
     * Execute the kernel that scales the velocities of particles associated with a nose hoover chain
     *
     * @param context the context in which to execute this kernel
     * @param noseHooverChain the chain whose energy is to be determined.
     * @param scaleFactor the multiplicative factor by which {absolute, relative} velocities are scaled.
     */
    void scaleVelocities(ContextImpl& context, const NoseHooverChain &noseHooverChain, std::pair<double, double> scaleFactor);
1197
1198
1199
1200
1201
1202
1203
1204
    /**
     * Write the chain states to a checkpoint.
     */
    void createCheckpoint(ContextImpl& context, std::ostream& stream) const;
    /**
     * Load the chain states from a checkpoint.
     */
    void loadCheckpoint(ContextImpl& context, std::istream& stream);
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
    /**
     * Get the internal states of all chains.
     * 
     * @param context       the context for which to get the states
     * @param positions     element [i][j] contains the position of bead j for chain i
     * @param velocities    element [i][j] contains the velocity of bead j for chain i
     */
    void getChainStates(ContextImpl& context, std::vector<std::vector<double> >& positions, std::vector<std::vector<double> >& velocities) const;
    /**
     * Set the internal states of all chains.
     * 
     * @param context       the context for which to get the states
     * @param positions     element [i][j] contains the position of bead j for chain i
     * @param velocities    element [i][j] contains the velocity of bead j for chain i
     */
    void setChainStates(ContextImpl& context, const std::vector<std::vector<double> >& positions, const std::vector<std::vector<double> >& velocities);
1221
1222
private:
    ReferencePlatform::PlatformData& data;
1223
1224
    ReferenceNoseHooverChain* chainPropagator;
    ReferenceNoseHooverDynamics* dynamics;
1225
    std::vector<double> masses;
1226
1227
    std::vector<std::vector<double> > chainPositions;
    std::vector<std::vector<double> > chainVelocities;
1228
    double prevStepSize;
1229
1230
1231
1232
1233
1234
1235
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class ReferenceIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
1236
    ReferenceIntegrateLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinStepKernel(name, platform),
1237
        data(data), dynamics(0) {
1238
    }
1239
    ~ReferenceIntegrateLangevinStepKernel();
1240
    /**
Peter Eastman's avatar
Peter Eastman committed
1241
     * Initialize the kernel, setting up the particle masses.
1242
     * 
1243
1244
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
1245
     */
1246
    void initialize(const System& system, const LangevinIntegrator& integrator);
1247
1248
1249
    /**
     * Execute the kernel.
     * 
1250
1251
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
1252
     */
1253
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
1254
1255
1256
1257
1258
1259
1260
    /**
     * 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);
1261
private:
1262
    ReferencePlatform::PlatformData& data;
1263
    ReferenceStochasticDynamics* dynamics;
peastman's avatar
peastman committed
1264
    std::vector<double> masses;
1265
    double prevTemp, prevFriction, prevStepSize;
1266
1267
};

1268
/**
1269
 * This kernel is invoked by LangevinMiddleIntegrator to take one time step.
1270
 */
1271
class ReferenceIntegrateLangevinMiddleStepKernel : public IntegrateLangevinMiddleStepKernel {
1272
public:
1273
    ReferenceIntegrateLangevinMiddleStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinMiddleStepKernel(name, platform),
1274
1275
        data(data), dynamics(0) {
    }
1276
    ~ReferenceIntegrateLangevinMiddleStepKernel();
1277
1278
1279
1280
    /**
     * Initialize the kernel, setting up the particle masses.
     * 
     * @param system     the System this kernel will be applied to
1281
     * @param integrator the LangevinMiddleIntegrator this kernel will be used for
1282
     */
1283
    void initialize(const System& system, const LangevinMiddleIntegrator& integrator);
1284
1285
1286
1287
    /**
     * Execute the kernel.
     * 
     * @param context    the context in which to execute this kernel
1288
     * @param integrator the LangevinMiddleIntegrator this kernel is being used for
1289
     */
1290
    void execute(ContextImpl& context, const LangevinMiddleIntegrator& integrator);
1291
1292
1293
1294
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
1295
     * @param integrator the LangevinMiddleIntegrator this kernel is being used for
1296
     */
1297
    double computeKineticEnergy(ContextImpl& context, const LangevinMiddleIntegrator& integrator);
1298
1299
private:
    ReferencePlatform::PlatformData& data;
1300
    ReferenceLangevinMiddleDynamics* dynamics;
1301
1302
1303
1304
    std::vector<double> masses;
    double prevTemp, prevFriction, prevStepSize;
};

1305
1306
1307
1308
1309
/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
1310
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
1311
        data(data), dynamics(0) {
1312
    }
1313
    ~ReferenceIntegrateBrownianStepKernel();
1314
    /**
1315
     * Initialize the kernel.
1316
     * 
1317
1318
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
1319
     */
1320
    void initialize(const System& system, const BrownianIntegrator& integrator);
1321
1322
1323
    /**
     * Execute the kernel.
     * 
1324
1325
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
1326
     */
1327
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
1328
1329
1330
1331
1332
1333
1334
    /**
     * 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);
1335
private:
1336
    ReferencePlatform::PlatformData& data;
1337
    ReferenceBrownianDynamics* dynamics;
peastman's avatar
peastman committed
1338
    std::vector<double> masses;
1339
    double prevTemp, prevFriction, prevStepSize;
1340
1341
};

1342
1343
1344
1345
1346
1347
/**
 * 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),
1348
        data(data), dynamics(0) {
1349
1350
1351
1352
1353
1354
    }
    ~ReferenceIntegrateVariableLangevinStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1355
     * @param integrator the VariableLangevinIntegrator this kernel will be used for
1356
1357
1358
1359
1360
1361
     */
    void initialize(const System& system, const VariableLangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1362
     * @param integrator the VariableLangevinIntegrator this kernel is being used for
1363
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1364
     * @return the size of the step that was taken
1365
     */
1366
    double execute(ContextImpl& context, const VariableLangevinIntegrator& integrator, double maxTime);
1367
1368
1369
1370
1371
1372
1373
    /**
     * 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);
1374
1375
1376
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableStochasticDynamics* dynamics;
peastman's avatar
peastman committed
1377
    std::vector<double> masses;
1378
1379
1380
    double prevTemp, prevFriction, prevErrorTol;
};

1381
1382
1383
1384
1385
1386
/**
 * 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),
1387
        data(data), dynamics(0) {
1388
1389
1390
1391
1392
1393
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1394
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1395
1396
1397
1398
1399
1400
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1401
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1402
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1403
     * @return the size of the step that was taken
1404
     */
1405
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1406
1407
1408
1409
1410
1411
1412
    /**
     * 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);
1413
1414
1415
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
peastman's avatar
peastman committed
1416
    std::vector<double> masses;
1417
    double prevErrorTol;
1418
1419
};

1420
1421
1422
1423
1424
1425
/**
 * 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),
1426
        data(data), dynamics(0) {
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
    }
    ~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);
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
    /**
     * 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);
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
    /**
     * 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
1491
1492
    std::vector<double> masses, globalValues;
    std::vector<std::vector<OpenMM::Vec3> > perDofValues; 
1493
1494
};

1495
/**
Peter Eastman's avatar
Peter Eastman committed
1496
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
1497
1498
1499
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
1500
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
1501
    }
1502
    ~ReferenceApplyAndersenThermostatKernel();
1503
    /**
1504
     * Initialize the kernel.
1505
     * 
1506
1507
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
1508
     */
1509
    void initialize(const System& system, const AndersenThermostat& thermostat);
1510
1511
1512
    /**
     * Execute the kernel.
     * 
1513
     * @param context    the context in which to execute this kernel
1514
     */
1515
    void execute(ContextImpl& context);
1516
1517
private:
    ReferenceAndersenThermostat* thermostat;
1518
    std::vector<std::vector<int> > particleGroups;
peastman's avatar
peastman committed
1519
    std::vector<double> masses;
1520
1521
};

1522
1523
1524
1525
1526
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
1527
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
1528
1529
1530
1531
1532
1533
1534
1535
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
1536
    void initialize(const System& system, const Force& barostat);
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
    /**
     * 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
     */
1549
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
    /**
     * 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;
};

1561
1562
1563
1564
1565
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1566
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1567
1568
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1569
     * Initialize the kernel, setting up the particle masses.
1570
     * 
1571
1572
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1573
     */
1574
    void initialize(const System& system, const CMMotionRemover& force);
1575
1576
1577
    /**
     * Execute the kernel.
     * 
1578
     * @param context    the context in which to execute this kernel
1579
     */
1580
    void execute(ContextImpl& context);
1581
private:
1582
    ReferencePlatform::PlatformData& data;
1583
    std::vector<double> masses;
1584
    int frequency;
1585
1586
};

1587
1588
1589
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/