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

35
#include "ReferencePlatform.h"
36
#include "openmm/kernels.h"
37
#include "openmm/internal/CustomNonbondedForceImpl.h"
38
39
#include "SimTKOpenMMRealType.h"
#include "ReferenceNeighborList.h"
40
#include "lepton/CompiledExpression.h"
41
#include "lepton/CustomFunction.h"
42
43
#include <array>
#include <utility>
44

45
46
namespace OpenMM {

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

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

115
/**
116
117
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
118
 */
119
class ReferenceUpdateStateDataKernel : public UpdateStateDataKernel {
120
public:
121
    ReferenceUpdateStateDataKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : UpdateStateDataKernel(name, platform), data(data) {
122
123
124
125
126
127
128
129
130
131
132
133
    }
    /**
     * 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
     */
134
    double getTime(const ContextImpl& context) const;
135
136
137
138
139
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
140
    void setTime(ContextImpl& context, double time);
141
142
143
144
145
146
147
148
149
150
151
152
    /**
     * Get the current step count
     *
     * @param context    the context in which to execute this kernel
     */
    long long getStepCount(const ContextImpl& context) const;
    /**
     * Set the current step count
     *
     * @param context    the context in which to execute this kernel
     */
    void setStepCount(const ContextImpl& context, long long count);
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    /**
     * 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);
177
178
179
180
181
182
183
184
185
    /**
     * Compute velocities, shifted in time to account for a leapfrog integrator.  The shift
     * is based on the most recently computed forces.
     * 
     * @param context     the context in which to execute this kernel
     * @param timeShift   the amount by which to shift the velocities in time
     * @param velocities  the shifted velocities are returned in this
     */
    void computeShiftedVelocities(ContextImpl& context, double timeShift, std::vector<Vec3>& velocities);
186
187
188
189
190
191
    /**
     * Get the current forces on all particles.
     *
     * @param forces  on exit, this contains the forces
     */
    void getForces(ContextImpl& context, std::vector<Vec3>& forces);
192
193
194
195
196
197
    /**
     * 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);
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
    /**
     * 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
     */
213
    void setPeriodicBoxVectors(ContextImpl& context, const Vec3& a, const Vec3& b, const Vec3& c);
Peter Eastman's avatar
Peter Eastman committed
214
215
216
217
218
219
220
221
222
223
224
225
    /**
     * 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);
226
227
private:
    ReferencePlatform::PlatformData& data;
228
    std::vector<double> masses;
229
230
};

231
232
233
234
235
236
/**
 * 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) :
237
            ApplyConstraintsKernel(name, platform), data(data) {
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    }
    ~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);
253
254
255
256
257
258
259
    /**
     * 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);
260
261
private:
    ReferencePlatform::PlatformData& data;
peastman's avatar
peastman committed
262
263
    std::vector<double> masses;
    std::vector<double> inverseMasses;
264
265
};

266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/**
 * 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);
};

287
/**
288
 * This kernel is invoked by HarmonicBondForce to calculate the forces acting on the system and the energy of the system.
289
 */
290
class ReferenceCalcHarmonicBondForceKernel : public CalcHarmonicBondForceKernel {
291
public:
292
    ReferenceCalcHarmonicBondForceKernel(std::string name, const Platform& platform) : CalcHarmonicBondForceKernel(name, platform) {
293
294
    }
    /**
295
     * Initialize the kernel.
296
     * 
297
     * @param system     the System this kernel will be applied to
298
299
300
301
     * @param force      the HarmonicBondForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicBondForce& force);
    /**
302
303
304
305
306
307
     * 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
308
     */
309
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
310
311
312
313
314
315
316
    /**
     * 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);
317
318
private:
    int numBonds;
319
320
    std::vector<std::vector<int> >bondIndexArray;
    std::vector<std::vector<double> >bondParamArray;
321
    bool usePeriodic;
322
323
};

324
325
326
327
328
/**
 * 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:
329
    ReferenceCalcCustomBondForceKernel(std::string name, const Platform& platform) : CalcCustomBondForceKernel(name, platform), ixn(NULL) {
330
    }
331
    ~ReferenceCalcCustomBondForceKernel();
332
333
334
335
336
337
338
339
    /**
     * 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);
    /**
340
     * Execute the kernel to calculate the forces and/or energy.
341
     *
342
343
344
345
     * @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
346
     */
347
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
348
349
350
351
352
353
354
    /**
     * 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);
355
356
private:
    int numBonds;
357
    ReferenceCustomBondIxn* ixn;
358
359
    std::vector<std::vector<int> >bondIndexArray;
    std::vector<std::vector<double> >bondParamArray;
360
    Lepton::CompiledExpression energyExpression, forceExpression;
361
362
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
363
    bool usePeriodic;
364
365
};

366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
/**
 * 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);
    /**
381
382
383
384
385
386
     * 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
387
     */
388
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
389
390
391
392
393
394
395
    /**
     * 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);
396
397
private:
    int numAngles;
398
399
    std::vector<std::vector<int> >angleIndexArray;
    std::vector<std::vector<double> >angleParamArray;
400
    bool usePeriodic;
401
402
};

403
404
405
406
407
/**
 * 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:
408
    ReferenceCalcCustomAngleForceKernel(std::string name, const Platform& platform) : CalcCustomAngleForceKernel(name, platform), ixn(NULL) {
409
    }
410
    ~ReferenceCalcCustomAngleForceKernel();
411
412
413
414
415
416
417
418
    /**
     * 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);
    /**
419
     * Execute the kernel to calculate the forces and/or energy.
420
     *
421
422
423
424
     * @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
425
     */
426
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
427
428
429
430
431
432
433
    /**
     * 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);
434
435
private:
    int numAngles;
436
    ReferenceCustomAngleIxn* ixn;
437
438
    std::vector<std::vector<int> >angleIndexArray;
    std::vector<std::vector<double> >angleParamArray;
439
    Lepton::CompiledExpression energyExpression, forceExpression;
440
441
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
442
    bool usePeriodic;
443
444
};

445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
/**
 * 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);
    /**
460
461
462
463
464
465
     * 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
466
     */
467
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
468
469
470
471
472
473
474
    /**
     * 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);
475
476
private:
    int numTorsions;
477
478
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
479
    bool usePeriodic;
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
};

/**
 * 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);
    /**
497
498
499
500
501
502
     * 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
503
     */
504
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
505
506
507
508
509
510
511
    /**
     * 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);
512
513
private:
    int numTorsions;
514
515
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
516
    bool usePeriodic;
517
518
};

519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
/**
 * 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);
    /**
534
     * Execute the kernel to calculate the forces and/or energy.
535
     *
536
537
538
539
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
540
     */
541
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
542
543
544
545
546
547
548
    /**
     * 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);
549
private:
peastman's avatar
peastman committed
550
    std::vector<std::vector<std::vector<double> > > coeff;
551
552
    std::vector<int> torsionMaps;
    std::vector<std::vector<int> > torsionIndices;
553
    bool usePeriodic;
554
555
};

556
557
558
559
560
/**
 * 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:
561
    ReferenceCalcCustomTorsionForceKernel(std::string name, const Platform& platform) : CalcCustomTorsionForceKernel(name, platform), ixn(NULL) {
562
    }
563
    ~ReferenceCalcCustomTorsionForceKernel();
564
565
566
567
568
569
570
571
    /**
     * 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);
    /**
572
     * Execute the kernel to calculate the forces and/or energy.
573
     *
574
575
576
577
     * @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
578
     */
579
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
580
581
582
583
584
585
586
    /**
     * 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);
587
588
private:
    int numTorsions;
589
    ReferenceCustomTorsionIxn* ixn;
590
591
    std::vector<std::vector<int> >torsionIndexArray;
    std::vector<std::vector<double> >torsionParamArray;
592
    Lepton::CompiledExpression energyExpression, forceExpression;
593
594
    std::vector<Lepton::CompiledExpression> energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, energyParamDerivNames;
595
    bool usePeriodic;
596
597
};

598
599
600
601
602
603
604
605
606
607
608
609
610
/**
 * 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
611
     */
612
    void initialize(const System& system, const NonbondedForce& force);
613
    /**
614
615
616
617
618
     * 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
619
     * @param includeReciprocal  true if reciprocal space interactions should be included
620
     * @return the potential energy due to the force
621
     */
622
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy, bool includeDirect, bool includeReciprocal);
623
624
625
626
627
628
629
    /**
     * 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);
630
631
632
633
634
635
636
637
638
    /**
     * 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;
639
640
641
    /**
     * Get the dispersion parameters being used for the dispersion term in LJPME.
     *
642
643
644
645
     * @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
646
     */
647
    void getLJPMEParameters(double& alpha, int& nx, int& ny, int& nz) const;
648
private:
649
    void computeParameters(ContextImpl& context);
Peter Eastman's avatar
Peter Eastman committed
650
    int numParticles, num14;
651
652
    std::vector<std::vector<int> >bonded14IndexArray;
    std::vector<std::vector<double> > particleParamArray, bonded14ParamArray;
653
654
    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
655
    double nonbondedCutoff, switchingDistance, rfDielectric, ewaldAlpha, ewaldDispersionAlpha, dispersionCoefficient;
656
    int kmax[3], gridSize[3], dispersionGridSize[3];
657
    bool useSwitchingFunction, exceptionsArePeriodic;
658
659
660
    std::vector<std::set<int> > exclusions;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
661
662
};

663
664
665
666
667
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
668
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform), forceCopy(NULL) {
669
670
671
672
673
674
675
676
677
678
    }
    ~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);
    /**
679
     * Execute the kernel to calculate the forces and/or energy.
680
     *
681
682
683
684
     * @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
685
     */
686
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
687
688
689
690
691
692
693
    /**
     * 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);
694
private:
695
    void createExpressions(const CustomNonbondedForce& force);
696
    int numParticles;
697
    std::vector<std::vector<double> > particleParamArray;
peastman's avatar
peastman committed
698
    double nonbondedCutoff, switchingDistance, periodicBoxSize[3], longRangeCoefficient;
699
    bool useSwitchingFunction, hasInitializedLongRangeCorrection;
700
    CustomNonbondedForce* forceCopy;
701
    CustomNonbondedForceImpl::LongRangeCorrectionData longRangeCorrectionData;
702
    std::map<std::string, double> globalParamValues;
703
    std::vector<std::set<int> > exclusions;
704
    Lepton::CompiledExpression energyExpression, forceExpression;
705
706
    std::vector<Lepton::CompiledExpression> computedValueExpressions, energyParamDerivExpressions;
    std::vector<std::string> parameterNames, globalParameterNames, computedValueNames, energyParamDerivNames;
707
    std::vector<std::pair<std::set<int>, std::set<int> > > interactionGroups;
708
    std::vector<double> longRangeCoefficientDerivs;
709
    std::map<std::string, int> tabulatedFunctionUpdateCount;
710
711
712
713
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

714
/**
715
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
716
 */
717
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
718
public:
719
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
720
    }
721
    ~ReferenceCalcGBSAOBCForceKernel();
722
    /**
723
     * Initialize the kernel.
724
     * 
725
     * @param system     the System this kernel will be applied to
726
     * @param force      the GBSAOBCForce this kernel will be used for
727
     */
728
    void initialize(const System& system, const GBSAOBCForce& force);
729
    /**
730
731
732
733
734
735
     * 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
736
     */
737
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
738
739
740
741
742
743
744
    /**
     * 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);
745
private:
746
    ReferenceObc* obc;
peastman's avatar
peastman committed
747
    std::vector<double> charges;
748
    bool isPeriodic;
749
750
};

751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
/**
 * 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);
    /**
767
     * Execute the kernel to calculate the forces and/or energy.
768
     *
769
770
771
772
     * @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
773
     */
774
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
775
776
777
778
779
780
781
    /**
     * 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);
782
private:
783
    void createExpressions(const CustomGBForce& force);
784
    int numParticles;
785
    bool isPeriodic;
786
    std::vector<std::vector<double> > particleParamArray;
peastman's avatar
peastman committed
787
    double nonbondedCutoff;
788
    std::vector<std::set<int> > exclusions;
789
    std::vector<std::string> particleParameterNames, globalParameterNames, energyParamDerivNames, valueNames;
790
791
792
    std::vector<Lepton::CompiledExpression> valueExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > valueGradientExpressions;
793
    std::vector<std::vector<Lepton::CompiledExpression> > valueParamDerivExpressions;
794
    std::vector<OpenMM::CustomGBForce::ComputationType> valueTypes;
795
796
797
    std::vector<Lepton::CompiledExpression> energyExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyDerivExpressions;
    std::vector<std::vector<Lepton::CompiledExpression> > energyGradientExpressions;
798
    std::vector<std::vector<Lepton::CompiledExpression> > energyParamDerivExpressions;
799
    std::vector<OpenMM::CustomGBForce::ComputationType> energyTypes;
800
    std::map<std::string, int> tabulatedFunctionUpdateCount;
801
802
803
804
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

805
806
807
808
809
/**
 * 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:
810
    ReferenceCalcCustomExternalForceKernel(std::string name, const Platform& platform) : CalcCustomExternalForceKernel(name, platform), ixn(NULL) {
811
    }
812
    ~ReferenceCalcCustomExternalForceKernel();
813
814
815
816
817
818
819
820
    /**
     * 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);
    /**
821
     * Execute the kernel to calculate the forces and/or energy.
822
     *
823
824
825
826
     * @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
827
     */
828
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
829
830
831
832
833
834
835
    /**
     * 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);
836
837
private:
    int numParticles;
838
    ReferenceCustomExternalIxn* ixn;
839
    std::vector<int> particles;
840
    std::vector<std::vector<double> > particleParamArray;
841
    Lepton::CompiledExpression energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
842
    std::vector<std::string> parameterNames, globalParameterNames;
peastman's avatar
peastman committed
843
    Vec3* boxVectors;
844
845
};

846
847
848
849
850
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
851
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
852
853
854
855
856
857
858
859
860
861
    }
    ~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);
    /**
862
     * Execute the kernel to calculate the forces and/or energy.
863
     *
864
865
866
867
     * @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
868
     */
869
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
870
871
872
873
874
875
876
    /**
     * 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);
877
private:
878
    void createInteraction(const CustomHbondForce& force);
879
    int numDonors, numAcceptors, numParticles;
880
    bool isPeriodic;
881
    std::vector<std::vector<int> > donorParticles, acceptorParticles;
882
    std::vector<std::vector<double> > donorParamArray, acceptorParamArray;
peastman's avatar
peastman committed
883
    double nonbondedCutoff;
884
    ReferenceCustomHbondIxn* ixn;
885
    std::vector<std::set<int> > exclusions;
886
    std::vector<std::string> globalParameterNames;
887
    std::map<std::string, int> tabulatedFunctionUpdateCount;
888
889
};

890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
/**
 * 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:
922
    void createInteraction(const CustomCentroidBondForce& force);
923
    int numBonds, numParticles;
924
925
926
    std::vector<std::vector<int> > bondGroups;
    std::vector<std::vector<int> > groupAtoms;
    std::vector<std::vector<double> > normalizedWeights;
927
    std::vector<std::vector<double> > bondParamArray;
928
    ReferenceCustomCentroidBondIxn* ixn;
929
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
930
    std::map<std::string, int> tabulatedFunctionUpdateCount;
931
    bool usePeriodic;
932
    Vec3* boxVectors;
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 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);
959
960
961
962
963
964
965
    /**
     * 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);
966
private:
967
    void createInteraction(const CustomCompoundBondForce& force);
968
    int numBonds;
969
    std::vector<std::vector<int> > bondParticles;
970
    std::vector<std::vector<double> > bondParamArray;
971
    ReferenceCustomCompoundBondIxn* ixn;
972
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
973
    std::map<std::string, int> tabulatedFunctionUpdateCount;
974
    bool usePeriodic;
975
    Vec3* boxVectors;
976
977
};

978
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
/**
 * 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
1011
    double cutoffDistance;
1012
    std::vector<std::vector<double> > particleParamArray;
1013
1014
    ReferenceCustomManyParticleIxn* ixn;
    std::vector<std::string> globalParameterNames;
1015
    std::map<std::string, int> tabulatedFunctionUpdateCount;
1016
1017
1018
    NonbondedMethod nonbondedMethod;
};

1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
/**
 * 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;
};

1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
/**
 * 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
1066
     * @param innerContext   the context created by the CustomCVForce for computing collective variables
1067
     */
1068
    void initialize(const System& system, const CustomCVForce& force, ContextImpl& innerContext);
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
    /**
     * 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);
1086
1087
1088
1089
1090
1091
1092
    /**
     * 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);
1093
1094
1095
1096
1097
private:
    ReferenceCustomCVForce* ixn;
    std::vector<std::string> globalParameterNames, energyParamDerivNames;
};

1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
/**
 * 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;
};

1133
1134
1135
1136
1137
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class ReferenceIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
1138
    ReferenceIntegrateVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVerletStepKernel(name, platform),
1139
        data(data), dynamics(0) {
1140
    }
1141
    ~ReferenceIntegrateVerletStepKernel();
1142
    /**
1143
     * Initialize the kernel.
1144
     * 
1145
1146
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
1147
     */
1148
    void initialize(const System& system, const VerletIntegrator& integrator);
1149
1150
1151
    /**
     * Execute the kernel.
     * 
1152
1153
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
1154
     */
1155
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
1156
1157
1158
1159
1160
1161
1162
    /**
     * 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);
1163
private:
1164
    ReferencePlatform::PlatformData& data;
1165
    ReferenceVerletDynamics* dynamics;
peastman's avatar
peastman committed
1166
    std::vector<double> masses;
1167
    double prevStepSize;
1168
1169
1170
}
;
/**
1171
 * This kernel is invoked by NoseHooverIntegrator to take one time step.
1172
 */
1173
class ReferenceIntegrateNoseHooverStepKernel : public IntegrateNoseHooverStepKernel {
1174
public:
1175
    ReferenceIntegrateNoseHooverStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateNoseHooverStepKernel(name, platform),
1176
1177
        data(data), dynamics(0) {
    }
1178
    ~ReferenceIntegrateNoseHooverStepKernel();
1179
1180
1181
1182
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
1183
     * @param integrator the NoseHooverIntegrator this kernel will be used for
1184
     */
1185
    void initialize(const System& system, const NoseHooverIntegrator& integrator);
1186
1187
1188
1189
1190
    /**
     * Execute the kernel.
     * 
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
1191
1192
     * @param forcesAreValid a reference to the parent integrator's boolean for keeping
     *                       track of the validity of the current forces.
1193
     */
1194
    void execute(ContextImpl& context, const NoseHooverIntegrator& integrator, bool &forcesAreValid);
1195
1196
1197
1198
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
1199
     * @param integrator the NoseHooverIntegrator this kernel is being used for
1200
     */
1201
    double computeKineticEnergy(ContextImpl& context, const NoseHooverIntegrator& integrator);
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
    /**
     * 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);
1237
1238
1239
1240
1241
1242
1243
1244
    /**
     * 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);
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
    /**
     * 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);
1261
1262
private:
    ReferencePlatform::PlatformData& data;
1263
1264
    ReferenceNoseHooverChain* chainPropagator;
    ReferenceNoseHooverDynamics* dynamics;
1265
    std::vector<double> masses;
1266
1267
    std::vector<std::vector<double> > chainPositions;
    std::vector<std::vector<double> > chainVelocities;
1268
    double prevStepSize;
1269
1270
1271
1272
1273
1274
1275
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class ReferenceIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
1276
    ReferenceIntegrateLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinStepKernel(name, platform),
1277
        data(data), dynamics(0) {
1278
    }
1279
    ~ReferenceIntegrateLangevinStepKernel();
1280
    /**
Peter Eastman's avatar
Peter Eastman committed
1281
     * Initialize the kernel, setting up the particle masses.
1282
     * 
1283
1284
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
1285
     */
1286
    void initialize(const System& system, const LangevinIntegrator& integrator);
1287
1288
1289
    /**
     * Execute the kernel.
     * 
1290
1291
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
1292
     */
1293
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
1294
1295
1296
1297
1298
1299
1300
    /**
     * 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);
1301
private:
1302
    ReferencePlatform::PlatformData& data;
1303
    ReferenceStochasticDynamics* dynamics;
peastman's avatar
peastman committed
1304
    std::vector<double> masses;
1305
    double prevTemp, prevFriction, prevStepSize;
1306
1307
};

1308
/**
1309
 * This kernel is invoked by LangevinMiddleIntegrator to take one time step.
1310
 */
1311
class ReferenceIntegrateLangevinMiddleStepKernel : public IntegrateLangevinMiddleStepKernel {
1312
public:
1313
    ReferenceIntegrateLangevinMiddleStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinMiddleStepKernel(name, platform),
1314
1315
        data(data), dynamics(0) {
    }
1316
    ~ReferenceIntegrateLangevinMiddleStepKernel();
1317
1318
1319
1320
    /**
     * Initialize the kernel, setting up the particle masses.
     * 
     * @param system     the System this kernel will be applied to
1321
     * @param integrator the LangevinMiddleIntegrator this kernel will be used for
1322
     */
1323
    void initialize(const System& system, const LangevinMiddleIntegrator& integrator);
1324
1325
1326
1327
    /**
     * Execute the kernel.
     * 
     * @param context    the context in which to execute this kernel
1328
     * @param integrator the LangevinMiddleIntegrator this kernel is being used for
1329
     */
1330
    void execute(ContextImpl& context, const LangevinMiddleIntegrator& integrator);
1331
1332
1333
1334
    /**
     * Compute the kinetic energy.
     * 
     * @param context    the context in which to execute this kernel
1335
     * @param integrator the LangevinMiddleIntegrator this kernel is being used for
1336
     */
1337
    double computeKineticEnergy(ContextImpl& context, const LangevinMiddleIntegrator& integrator);
1338
1339
private:
    ReferencePlatform::PlatformData& data;
1340
    ReferenceLangevinMiddleDynamics* dynamics;
1341
1342
1343
1344
    std::vector<double> masses;
    double prevTemp, prevFriction, prevStepSize;
};

1345
1346
1347
1348
1349
/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
1350
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
1351
        data(data), dynamics(0) {
1352
    }
1353
    ~ReferenceIntegrateBrownianStepKernel();
1354
    /**
1355
     * Initialize the kernel.
1356
     * 
1357
1358
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
1359
     */
1360
    void initialize(const System& system, const BrownianIntegrator& integrator);
1361
1362
1363
    /**
     * Execute the kernel.
     * 
1364
1365
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
1366
     */
1367
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
1368
1369
1370
1371
1372
1373
1374
    /**
     * 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);
1375
private:
1376
    ReferencePlatform::PlatformData& data;
1377
    ReferenceBrownianDynamics* dynamics;
peastman's avatar
peastman committed
1378
    std::vector<double> masses;
1379
    double prevTemp, prevFriction, prevStepSize;
1380
1381
};

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

1421
1422
1423
1424
1425
1426
/**
 * 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),
1427
        data(data), dynamics(0) {
1428
1429
1430
1431
1432
1433
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1434
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1435
1436
1437
1438
1439
1440
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1441
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1442
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1443
     * @return the size of the step that was taken
1444
     */
1445
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1446
1447
1448
1449
1450
1451
1452
    /**
     * 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);
1453
1454
1455
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
peastman's avatar
peastman committed
1456
    std::vector<double> masses;
1457
    double prevErrorTol;
1458
1459
};

1460
1461
1462
1463
1464
1465
/**
 * 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),
1466
        data(data), dynamics(0) {
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
    }
    ~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);
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
    /**
     * 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);
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
    /**
     * 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
1531
1532
    std::vector<double> masses, globalValues;
    std::vector<std::vector<OpenMM::Vec3> > perDofValues; 
1533
1534
};

1535
/**
Peter Eastman's avatar
Peter Eastman committed
1536
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
1537
1538
1539
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
1540
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
1541
    }
1542
    ~ReferenceApplyAndersenThermostatKernel();
1543
    /**
1544
     * Initialize the kernel.
1545
     * 
1546
1547
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
1548
     */
1549
    void initialize(const System& system, const AndersenThermostat& thermostat);
1550
1551
1552
    /**
     * Execute the kernel.
     * 
1553
     * @param context    the context in which to execute this kernel
1554
     */
1555
    void execute(ContextImpl& context);
1556
1557
private:
    ReferenceAndersenThermostat* thermostat;
1558
    std::vector<std::vector<int> > particleGroups;
peastman's avatar
peastman committed
1559
    std::vector<double> masses;
1560
1561
};

1562
1563
1564
1565
1566
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
1567
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
1568
1569
1570
1571
1572
1573
1574
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
1575
     * @param rigidMolecules  whether molecules should be kept rigid while scaling coordinates
1576
     */
1577
    void initialize(const System& system, const Force& barostat, bool rigidMolecules=true);
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
    /**
     * 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
     */
1590
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1591
1592
1593
1594
1595
1596
1597
1598
    /**
     * 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:
1599
    bool rigidMolecules;
1600
1601
1602
    ReferenceMonteCarloBarostat* barostat;
};

1603
1604
1605
1606
1607
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1608
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1609
1610
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1611
     * Initialize the kernel, setting up the particle masses.
1612
     * 
1613
1614
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1615
     */
1616
    void initialize(const System& system, const CMMotionRemover& force);
1617
1618
1619
    /**
     * Execute the kernel.
     * 
1620
     * @param context    the context in which to execute this kernel
1621
     */
1622
    void execute(ContextImpl& context);
1623
private:
1624
    ReferencePlatform::PlatformData& data;
1625
    std::vector<double> masses;
1626
    int frequency;
1627
1628
};

1629
1630
1631
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/