ReferenceKernels.h 50.9 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-2013 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/ExpressionProgram.h"
41

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

56
57
namespace OpenMM {

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

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

188
189
190
191
192
193
/**
 * 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) :
194
            ApplyConstraintsKernel(name, platform), data(data), constraints(0) {
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
    }
    ~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);
210
211
212
213
214
215
216
    /**
     * 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);
217
218
219
private:
    ReferencePlatform::PlatformData& data;
    ReferenceConstraintAlgorithm* constraints;
220
221
    std::vector<RealOpenMM> masses;
    std::vector<RealOpenMM> inverseMasses;
222
223
    std::vector<std::pair<int, int> > constraintIndices;
    std::vector<RealOpenMM> constraintDistances;
224
225
226
    int numConstraints;
};

227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/**
 * 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);
};

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

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

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/**
 * This kernel is invoked by HarmonicAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcHarmonicAngleForceKernel : public CalcHarmonicAngleForceKernel {
public:
    ReferenceCalcHarmonicAngleForceKernel(std::string name, const Platform& platform) : CalcHarmonicAngleForceKernel(name, platform) {
    }
    ~ReferenceCalcHarmonicAngleForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     * @param force      the HarmonicAngleForce this kernel will be used for
     */
    void initialize(const System& system, const HarmonicAngleForce& force);
    /**
340
341
342
343
344
345
     * 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
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 HarmonicAngleForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const HarmonicAngleForce& force);
355
356
357
358
359
360
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
};

361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
/**
 * This kernel is invoked by CustomAngleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomAngleForceKernel : public CalcCustomAngleForceKernel {
public:
    ReferenceCalcCustomAngleForceKernel(std::string name, const Platform& platform) : CalcCustomAngleForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomAngleForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomAngleForce this kernel will be used for
     */
    void initialize(const System& system, const CustomAngleForce& force);
    /**
377
     * Execute the kernel to calculate the forces and/or energy.
378
     *
379
380
381
382
     * @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
383
     */
384
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
385
386
387
388
389
390
391
    /**
     * 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);
392
393
394
395
private:
    int numAngles;
    int **angleIndexArray;
    RealOpenMM **angleParamArray;
396
    Lepton::CompiledExpression energyExpression, forceExpression;
397
398
399
    std::vector<std::string> parameterNames, globalParameterNames;
};

400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
/**
 * This kernel is invoked by PeriodicTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcPeriodicTorsionForceKernel : public CalcPeriodicTorsionForceKernel {
public:
    ReferenceCalcPeriodicTorsionForceKernel(std::string name, const Platform& platform) : CalcPeriodicTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcPeriodicTorsionForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     * @param force      the PeriodicTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const PeriodicTorsionForce& force);
    /**
416
417
418
419
420
421
     * 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
422
     */
423
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
424
425
426
427
428
429
430
    /**
     * 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);
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
};

/**
 * This kernel is invoked by RBTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcRBTorsionForceKernel : public CalcRBTorsionForceKernel {
public:
    ReferenceCalcRBTorsionForceKernel(std::string name, const Platform& platform) : CalcRBTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcRBTorsionForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system     the System this kernel will be applied to
     * @param force      the RBTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const RBTorsionForce& force);
    /**
453
454
455
456
457
458
     * 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
459
     */
460
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
461
462
463
464
465
466
467
    /**
     * 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);
468
469
470
471
472
473
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
};

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
/**
 * 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);
    /**
489
     * Execute the kernel to calculate the forces and/or energy.
490
     *
491
492
493
494
     * @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
495
     */
496
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
497
498
499
500
501
502
private:
    std::vector<std::vector<std::vector<RealOpenMM> > > coeff;
    std::vector<int> torsionMaps;
    std::vector<std::vector<int> > torsionIndices;
};

503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
/**
 * This kernel is invoked by CustomTorsionForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomTorsionForceKernel : public CalcCustomTorsionForceKernel {
public:
    ReferenceCalcCustomTorsionForceKernel(std::string name, const Platform& platform) : CalcCustomTorsionForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomTorsionForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomTorsionForce this kernel will be used for
     */
    void initialize(const System& system, const CustomTorsionForce& force);
    /**
519
     * Execute the kernel to calculate the forces and/or energy.
520
     *
521
522
523
524
     * @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
525
     */
526
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
527
528
529
530
531
532
533
    /**
     * 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);
534
535
536
537
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
538
    Lepton::CompiledExpression energyExpression, forceExpression;
539
540
541
    std::vector<std::string> parameterNames, globalParameterNames;
};

542
543
544
545
546
547
548
549
550
551
552
553
554
/**
 * 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
555
     */
556
    void initialize(const System& system, const NonbondedForce& force);
557
    /**
558
559
560
561
562
     * 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
563
     * @param includeReciprocal  true if reciprocal space interactions should be included
564
     * @return the potential energy due to the force
565
     */
566
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy, bool includeDirect, bool includeReciprocal);
567
568
569
570
571
572
573
    /**
     * 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);
574
private:
Peter Eastman's avatar
Peter Eastman committed
575
    int numParticles, num14;
576
    int **bonded14IndexArray;
Peter Eastman's avatar
Peter Eastman committed
577
    RealOpenMM **particleParamArray, **bonded14ParamArray;
578
    RealOpenMM nonbondedCutoff, switchingDistance, rfDielectric, ewaldAlpha, dispersionCoefficient;
579
    int kmax[3], gridSize[3];
580
    bool useSwitchingFunction;
581
582
583
    std::vector<std::set<int> > exclusions;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
584
585
};

586
587
588
589
590
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
591
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform), forceCopy(NULL) {
592
593
594
595
596
597
598
599
600
601
    }
    ~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);
    /**
602
     * Execute the kernel to calculate the forces and/or energy.
603
     *
604
605
606
607
     * @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
608
     */
609
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
610
611
612
613
614
615
616
    /**
     * 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);
617
private:
618
619
    int numParticles;
    RealOpenMM **particleParamArray;
620
621
    RealOpenMM nonbondedCutoff, switchingDistance, periodicBoxSize[3], longRangeCoefficient;
    bool useSwitchingFunction, hasInitializedLongRangeCorrection;
622
623
    CustomNonbondedForce* forceCopy;
    std::map<std::string, double> globalParamValues;
624
    std::vector<std::set<int> > exclusions;
625
    Lepton::CompiledExpression energyExpression, forceExpression;
626
    std::vector<std::string> parameterNames, globalParameterNames;
627
    std::vector<std::pair<std::set<int>, std::set<int> > > interactionGroups;
628
629
630
631
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

632
/**
633
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
634
 */
635
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
636
public:
637
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
638
    }
639
    ~ReferenceCalcGBSAOBCForceKernel();
640
    /**
641
     * Initialize the kernel.
642
     * 
643
     * @param system     the System this kernel will be applied to
644
     * @param force      the GBSAOBCForce this kernel will be used for
645
     */
646
    void initialize(const System& system, const GBSAOBCForce& force);
647
    /**
648
649
650
651
652
653
     * 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
654
     */
655
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
656
657
658
659
660
661
662
    /**
     * 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);
663
664
665
private:
    CpuObc* obc;
    std::vector<RealOpenMM> charges;
666
    bool isPeriodic;
667
668
};

Mark Friedrichs's avatar
Mark Friedrichs committed
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
/**
 * This kernel is invoked by GBVIForce to calculate the forces acting on the system.
 */
class ReferenceCalcGBVIForceKernel : public CalcGBVIForceKernel {
public:
    ReferenceCalcGBVIForceKernel(std::string name, const Platform& platform) : CalcGBVIForceKernel(name, platform) {
    }
    ~ReferenceCalcGBVIForceKernel();
    /**
     * Initialize the kernel.
     * 
     * @param system       the System this kernel will be applied to
     * @param force        the GBVIForce this kernel will be used for
     * @param scaled radii the scaled radii (Eq. 5 of Labute paper)
     */
    void initialize(const System& system, const GBVIForce& force, const std::vector<double> & scaledRadii);
    /**
686
687
688
689
690
691
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
Mark Friedrichs's avatar
Mark Friedrichs committed
692
     */
693
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
Mark Friedrichs's avatar
Mark Friedrichs committed
694
695
696
private:
    CpuGBVI * gbvi;
    std::vector<RealOpenMM> charges;
697
    bool isPeriodic;
Mark Friedrichs's avatar
Mark Friedrichs committed
698
699
};

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

750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
/**
 * This kernel is invoked by CustomExternalForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomExternalForceKernel : public CalcCustomExternalForceKernel {
public:
    ReferenceCalcCustomExternalForceKernel(std::string name, const Platform& platform) : CalcCustomExternalForceKernel(name, platform) {
    }
    ~ReferenceCalcCustomExternalForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomExternalForce this kernel will be used for
     */
    void initialize(const System& system, const CustomExternalForce& force);
    /**
766
     * Execute the kernel to calculate the forces and/or energy.
767
     *
768
769
770
771
     * @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
772
     */
773
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
774
775
776
777
778
779
780
    /**
     * 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);
781
782
783
784
private:
    int numParticles;
    std::vector<int> particles;
    RealOpenMM **particleParamArray;
785
    Lepton::CompiledExpression energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
786
787
788
    std::vector<std::string> parameterNames, globalParameterNames;
};

789
790
791
792
793
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
794
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
795
796
797
798
799
800
801
802
803
804
    }
    ~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);
    /**
805
     * Execute the kernel to calculate the forces and/or energy.
806
     *
807
808
809
810
     * @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
811
     */
812
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
813
814
815
816
817
818
819
    /**
     * 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);
820
821
private:
    int numDonors, numAcceptors, numParticles;
822
    bool isPeriodic;
823
    RealOpenMM **donorParamArray, **acceptorParamArray;
824
    RealOpenMM nonbondedCutoff;
825
    ReferenceCustomHbondIxn* ixn;
826
    std::vector<std::set<int> > exclusions;
827
    std::vector<std::string> globalParameterNames;
828
829
};

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
/**
 * 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);
854
855
856
857
858
859
860
    /**
     * 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);
861
862
863
864
865
866
867
private:
    int numBonds, numParticles;
    RealOpenMM **bondParamArray;
    ReferenceCustomCompoundBondIxn* ixn;
    std::vector<std::string> globalParameterNames;
};

868
869
870
871
872
/**
 * This kernel is invoked by VerletIntegrator to take one time step.
 */
class ReferenceIntegrateVerletStepKernel : public IntegrateVerletStepKernel {
public:
873
    ReferenceIntegrateVerletStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateVerletStepKernel(name, platform),
874
        data(data), dynamics(0), constraints(0) {
875
    }
876
    ~ReferenceIntegrateVerletStepKernel();
877
    /**
878
     * Initialize the kernel.
879
     * 
880
881
     * @param system     the System this kernel will be applied to
     * @param integrator the VerletIntegrator this kernel will be used for
882
     */
883
    void initialize(const System& system, const VerletIntegrator& integrator);
884
885
886
    /**
     * Execute the kernel.
     * 
887
888
     * @param context    the context in which to execute this kernel
     * @param integrator the VerletIntegrator this kernel is being used for
889
     */
890
    void execute(ContextImpl& context, const VerletIntegrator& integrator);
891
892
893
894
895
896
897
    /**
     * 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);
898
private:
899
    ReferencePlatform::PlatformData& data;
900
    ReferenceVerletDynamics* dynamics;
901
    ReferenceConstraintAlgorithm* constraints;
902
    std::vector<RealOpenMM> masses;
903
904
    int numConstraints;
    double prevStepSize;
905
906
907
908
909
910
911
};

/**
 * This kernel is invoked by LangevinIntegrator to take one time step.
 */
class ReferenceIntegrateLangevinStepKernel : public IntegrateLangevinStepKernel {
public:
912
    ReferenceIntegrateLangevinStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateLangevinStepKernel(name, platform),
913
        data(data), dynamics(0), constraints(0) {
914
    }
915
    ~ReferenceIntegrateLangevinStepKernel();
916
    /**
Peter Eastman's avatar
Peter Eastman committed
917
     * Initialize the kernel, setting up the particle masses.
918
     * 
919
920
     * @param system     the System this kernel will be applied to
     * @param integrator the LangevinIntegrator this kernel will be used for
921
     */
922
    void initialize(const System& system, const LangevinIntegrator& integrator);
923
924
925
    /**
     * Execute the kernel.
     * 
926
927
     * @param context    the context in which to execute this kernel
     * @param integrator the LangevinIntegrator this kernel is being used for
928
     */
929
    void execute(ContextImpl& context, const LangevinIntegrator& integrator);
930
931
932
933
934
935
936
    /**
     * 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);
937
private:
938
    ReferencePlatform::PlatformData& data;
939
    ReferenceStochasticDynamics* dynamics;
940
    ReferenceConstraintAlgorithm* constraints;
941
    std::vector<RealOpenMM> masses;
942
943
    int numConstraints;
    double prevTemp, prevFriction, prevStepSize;
944
945
946
947
948
949
950
};

/**
 * This kernel is invoked by BrownianIntegrator to take one time step.
 */
class ReferenceIntegrateBrownianStepKernel : public IntegrateBrownianStepKernel {
public:
951
    ReferenceIntegrateBrownianStepKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : IntegrateBrownianStepKernel(name, platform),
952
        data(data), dynamics(0), constraints(0) {
953
    }
954
    ~ReferenceIntegrateBrownianStepKernel();
955
    /**
956
     * Initialize the kernel.
957
     * 
958
959
     * @param system     the System this kernel will be applied to
     * @param integrator the BrownianIntegrator this kernel will be used for
960
     */
961
    void initialize(const System& system, const BrownianIntegrator& integrator);
962
963
964
    /**
     * Execute the kernel.
     * 
965
966
     * @param context    the context in which to execute this kernel
     * @param integrator the BrownianIntegrator this kernel is being used for
967
     */
968
    void execute(ContextImpl& context, const BrownianIntegrator& integrator);
969
970
971
972
973
974
975
    /**
     * 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);
976
private:
977
    ReferencePlatform::PlatformData& data;
978
    ReferenceBrownianDynamics* dynamics;
979
    ReferenceConstraintAlgorithm* constraints;
980
    std::vector<RealOpenMM> masses;
981
982
    int numConstraints;
    double prevTemp, prevFriction, prevStepSize;
983
984
};

985
986
987
988
989
990
/**
 * 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),
991
        data(data), dynamics(0), constraints(0) {
992
993
994
995
996
997
    }
    ~ReferenceIntegrateVariableLangevinStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
998
     * @param integrator the VariableLangevinIntegrator this kernel will be used for
999
1000
1001
1002
1003
1004
     */
    void initialize(const System& system, const VariableLangevinIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1005
     * @param integrator the VariableLangevinIntegrator this kernel is being used for
1006
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1007
     * @return the size of the step that was taken
1008
     */
1009
    double execute(ContextImpl& context, const VariableLangevinIntegrator& integrator, double maxTime);
1010
1011
1012
1013
1014
1015
1016
    /**
     * 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);
1017
1018
1019
1020
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableStochasticDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
1021
    std::vector<RealOpenMM> masses;
1022
1023
1024
1025
    int numConstraints;
    double prevTemp, prevFriction, prevErrorTol;
};

1026
1027
1028
1029
1030
1031
/**
 * 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),
1032
        data(data), dynamics(0), constraints(0) {
1033
1034
1035
1036
1037
1038
    }
    ~ReferenceIntegrateVariableVerletStepKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
1039
     * @param integrator the VariableVerletIntegrator this kernel will be used for
1040
1041
1042
1043
1044
1045
     */
    void initialize(const System& system, const VariableVerletIntegrator& integrator);
    /**
     * Execute the kernel.
     *
     * @param context    the context in which to execute this kernel
1046
     * @param integrator the VariableVerletIntegrator this kernel is being used for
1047
     * @param maxTime    the maximum time beyond which the simulation should not be advanced
1048
     * @return the size of the step that was taken
1049
     */
1050
    double execute(ContextImpl& context, const VariableVerletIntegrator& integrator, double maxTime);
1051
1052
1053
1054
1055
1056
1057
    /**
     * 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);
1058
1059
1060
1061
private:
    ReferencePlatform::PlatformData& data;
    ReferenceVariableVerletDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
1062
    std::vector<RealOpenMM> masses;
1063
    int numConstraints;
1064
    double prevErrorTol;
1065
1066
};

1067
1068
1069
1070
1071
1072
/**
 * 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),
1073
        data(data), dynamics(0), constraints(0) {
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
    }
    ~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);
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
    /**
     * 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);
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
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
    /**
     * Get the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    on exit, this contains the values
     */
    void getGlobalVariables(ContextImpl& context, std::vector<double>& values) const;
    /**
     * Set the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    a vector containing the values
     */
    void setGlobalVariables(ContextImpl& context, const std::vector<double>& values);
    /**
     * Get the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    on exit, this contains the values
     */
    void getPerDofVariable(ContextImpl& context, int variable, std::vector<Vec3>& values) const;
    /**
     * Set the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    a vector containing the values
     */
    void setPerDofVariable(ContextImpl& context, int variable, const std::vector<Vec3>& values);
private:
    ReferencePlatform::PlatformData& data;
    ReferenceCustomDynamics* dynamics;
    ReferenceConstraintAlgorithm* constraints;
    std::vector<RealOpenMM> masses, globalValues;
    std::vector<std::vector<OpenMM::RealVec> > perDofValues; 
    int numConstraints;
};

1144
/**
Peter Eastman's avatar
Peter Eastman committed
1145
 * This kernel is invoked by AndersenThermostat at the start of each time step to adjust the particle velocities.
1146
1147
1148
 */
class ReferenceApplyAndersenThermostatKernel : public ApplyAndersenThermostatKernel {
public:
1149
    ReferenceApplyAndersenThermostatKernel(std::string name, const Platform& platform) : ApplyAndersenThermostatKernel(name, platform), thermostat(0) {
1150
    }
1151
    ~ReferenceApplyAndersenThermostatKernel();
1152
    /**
1153
     * Initialize the kernel.
1154
     * 
1155
1156
     * @param system     the System this kernel will be applied to
     * @param thermostat the AndersenThermostat this kernel will be used for
1157
     */
1158
    void initialize(const System& system, const AndersenThermostat& thermostat);
1159
1160
1161
    /**
     * Execute the kernel.
     * 
1162
     * @param context    the context in which to execute this kernel
1163
     */
1164
    void execute(ContextImpl& context);
1165
1166
private:
    ReferenceAndersenThermostat* thermostat;
1167
    std::vector<std::vector<int> > particleGroups;
1168
    std::vector<RealOpenMM> masses;
1169
1170
};

1171
1172
1173
1174
1175
/**
 * This kernel is invoked by MonteCarloBarostat to adjust the periodic box volume
 */
class ReferenceApplyMonteCarloBarostatKernel : public ApplyMonteCarloBarostatKernel {
public:
1176
    ReferenceApplyMonteCarloBarostatKernel(std::string name, const Platform& platform) : ApplyMonteCarloBarostatKernel(name, platform), barostat(NULL) {
1177
1178
1179
1180
1181
1182
1183
1184
    }
    ~ReferenceApplyMonteCarloBarostatKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param barostat   the MonteCarloBarostat this kernel will be used for
     */
1185
    void initialize(const System& system, const Force& barostat);
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
    /**
     * 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
     */
1198
    void scaleCoordinates(ContextImpl& context, double scaleX, double scaleY, double scaleZ);
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
    /**
     * 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;
};

1210
1211
1212
1213
1214
/**
 * This kernel is invoked to remove center of mass motion from the system.
 */
class ReferenceRemoveCMMotionKernel : public RemoveCMMotionKernel {
public:
1215
    ReferenceRemoveCMMotionKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : RemoveCMMotionKernel(name, platform), data(data) {
1216
1217
    }
    /**
Peter Eastman's avatar
Peter Eastman committed
1218
     * Initialize the kernel, setting up the particle masses.
1219
     * 
1220
1221
     * @param system     the System this kernel will be applied to
     * @param force      the CMMotionRemover this kernel will be used for
1222
     */
1223
    void initialize(const System& system, const CMMotionRemover& force);
1224
1225
1226
    /**
     * Execute the kernel.
     * 
1227
     * @param context    the context in which to execute this kernel
1228
     */
1229
    void execute(ContextImpl& context);
1230
private:
1231
    ReferencePlatform::PlatformData& data;
1232
    std::vector<double> masses;
1233
    int frequency;
1234
1235
};

1236
1237
1238
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/