ReferenceKernels.h 54.4 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-2015 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
43
namespace OpenMM {

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

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

104
/**
105
106
 * This kernel provides methods for setting and retrieving various state data: time, positions,
 * velocities, and forces.
107
 */
108
class ReferenceUpdateStateDataKernel : public UpdateStateDataKernel {
109
public:
110
    ReferenceUpdateStateDataKernel(std::string name, const Platform& platform, ReferencePlatform::PlatformData& data) : UpdateStateDataKernel(name, platform), data(data) {
111
112
113
114
115
116
117
118
119
120
121
122
    }
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     */
    void initialize(const System& system);
    /**
     * Get the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
123
    double getTime(const ContextImpl& context) const;
124
125
126
127
128
    /**
     * Set the current time (in picoseconds).
     *
     * @param context    the context in which to execute this kernel
     */
129
    void setTime(ContextImpl& context, double time);
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
    /**
     * Get the positions of all particles.
     *
     * @param positions  on exit, this contains the particle positions
     */
    void getPositions(ContextImpl& context, std::vector<Vec3>& positions);
    /**
     * Set the positions of all particles.
     *
     * @param positions  a vector containg the particle positions
     */
    void setPositions(ContextImpl& context, const std::vector<Vec3>& positions);
    /**
     * Get the velocities of all particles.
     *
     * @param velocities  on exit, this contains the particle velocities
     */
    void getVelocities(ContextImpl& context, std::vector<Vec3>& velocities);
    /**
     * Set the velocities of all particles.
     *
     * @param velocities  a vector containg the particle velocities
     */
    void setVelocities(ContextImpl& context, const std::vector<Vec3>& velocities);
    /**
     * Get the current forces on all particles.
     *
     * @param forces  on exit, this contains the forces
     */
    void getForces(ContextImpl& context, std::vector<Vec3>& forces);
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
    /**
     * 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
176
177
178
179
180
181
182
183
184
185
186
187
    /**
     * 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);
188
189
190
191
private:
    ReferencePlatform::PlatformData& data;
};

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

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
503
    /**
     * 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);
504
505
506
507
508
509
private:
    std::vector<std::vector<std::vector<RealOpenMM> > > coeff;
    std::vector<int> torsionMaps;
    std::vector<std::vector<int> > torsionIndices;
};

510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
/**
 * 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);
    /**
526
     * Execute the kernel to calculate the forces and/or energy.
527
     *
528
529
530
531
     * @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
532
     */
533
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
534
535
536
537
538
539
540
    /**
     * 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);
541
542
543
544
private:
    int numTorsions;
    int **torsionIndexArray;
    RealOpenMM **torsionParamArray;
545
    Lepton::CompiledExpression energyExpression, forceExpression;
546
547
548
    std::vector<std::string> parameterNames, globalParameterNames;
};

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

602
603
604
605
606
/**
 * This kernel is invoked by CustomNonbondedForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomNonbondedForceKernel : public CalcCustomNonbondedForceKernel {
public:
607
    ReferenceCalcCustomNonbondedForceKernel(std::string name, const Platform& platform) : CalcCustomNonbondedForceKernel(name, platform), forceCopy(NULL) {
608
609
610
611
612
613
614
615
616
617
    }
    ~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);
    /**
618
     * Execute the kernel to calculate the forces and/or energy.
619
     *
620
621
622
623
     * @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
624
     */
625
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
626
627
628
629
630
631
632
    /**
     * 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);
633
private:
634
635
    int numParticles;
    RealOpenMM **particleParamArray;
636
637
    RealOpenMM nonbondedCutoff, switchingDistance, periodicBoxSize[3], longRangeCoefficient;
    bool useSwitchingFunction, hasInitializedLongRangeCorrection;
638
639
    CustomNonbondedForce* forceCopy;
    std::map<std::string, double> globalParamValues;
640
    std::vector<std::set<int> > exclusions;
641
    Lepton::CompiledExpression energyExpression, forceExpression;
642
    std::vector<std::string> parameterNames, globalParameterNames;
643
    std::vector<std::pair<std::set<int>, std::set<int> > > interactionGroups;
644
645
646
647
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

648
/**
649
 * This kernel is invoked by GBSAOBCForce to calculate the forces acting on the system.
650
 */
651
class ReferenceCalcGBSAOBCForceKernel : public CalcGBSAOBCForceKernel {
652
public:
653
    ReferenceCalcGBSAOBCForceKernel(std::string name, const Platform& platform) : CalcGBSAOBCForceKernel(name, platform) {
654
    }
655
    ~ReferenceCalcGBSAOBCForceKernel();
656
    /**
657
     * Initialize the kernel.
658
     * 
659
     * @param system     the System this kernel will be applied to
660
     * @param force      the GBSAOBCForce this kernel will be used for
661
     */
662
    void initialize(const System& system, const GBSAOBCForce& force);
663
    /**
664
665
666
667
668
669
     * 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
670
     */
671
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
672
673
674
675
676
677
678
    /**
     * 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);
679
private:
680
    ReferenceObc* obc;
681
    std::vector<RealOpenMM> charges;
682
    bool isPeriodic;
683
684
};

Mark Friedrichs's avatar
Mark Friedrichs committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
/**
 * 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);
    /**
702
703
704
705
706
707
     * 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
708
     */
709
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
Mark Friedrichs's avatar
Mark Friedrichs committed
710
private:
711
    ReferenceGBVI * gbvi;
Mark Friedrichs's avatar
Mark Friedrichs committed
712
    std::vector<RealOpenMM> charges;
713
    bool isPeriodic;
Mark Friedrichs's avatar
Mark Friedrichs committed
714
715
};

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
/**
 * 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);
    /**
732
     * Execute the kernel to calculate the forces and/or energy.
733
     *
734
735
736
737
     * @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
738
     */
739
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
740
741
742
743
744
745
746
    /**
     * 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);
747
748
private:
    int numParticles;
749
    bool isPeriodic;
750
    RealOpenMM **particleParamArray;
751
    RealOpenMM nonbondedCutoff;
752
753
754
    std::vector<std::set<int> > exclusions;
    std::vector<std::string> particleParameterNames, globalParameterNames, valueNames;
    std::vector<Lepton::ExpressionProgram> valueExpressions;
755
    std::vector<std::vector<Lepton::ExpressionProgram> > valueDerivExpressions;
756
    std::vector<std::vector<Lepton::ExpressionProgram> > valueGradientExpressions;
757
758
759
    std::vector<OpenMM::CustomGBForce::ComputationType> valueTypes;
    std::vector<Lepton::ExpressionProgram> energyExpressions;
    std::vector<std::vector<Lepton::ExpressionProgram> > energyDerivExpressions;
760
    std::vector<std::vector<Lepton::ExpressionProgram> > energyGradientExpressions;
761
762
763
764
765
    std::vector<OpenMM::CustomGBForce::ComputationType> energyTypes;
    NonbondedMethod nonbondedMethod;
    NeighborList* neighborList;
};

766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
/**
 * This kernel is invoked by CustomExternalForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomExternalForceKernel : public CalcCustomExternalForceKernel {
public:
    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);
    /**
782
     * Execute the kernel to calculate the forces and/or energy.
783
     *
784
785
786
787
     * @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
788
     */
789
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
790
791
792
793
794
795
796
    /**
     * 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);
797
798
799
800
private:
    int numParticles;
    std::vector<int> particles;
    RealOpenMM **particleParamArray;
801
    Lepton::CompiledExpression energyExpression, forceExpressionX, forceExpressionY, forceExpressionZ;
802
803
804
    std::vector<std::string> parameterNames, globalParameterNames;
};

805
806
807
808
809
/**
 * This kernel is invoked by CustomHbondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomHbondForceKernel : public CalcCustomHbondForceKernel {
public:
810
    ReferenceCalcCustomHbondForceKernel(std::string name, const Platform& platform) : CalcCustomHbondForceKernel(name, platform), ixn(NULL) {
811
812
813
814
815
816
817
818
819
820
    }
    ~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);
    /**
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 CustomHbondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomHbondForce& force);
836
837
private:
    int numDonors, numAcceptors, numParticles;
838
    bool isPeriodic;
839
    RealOpenMM **donorParamArray, **acceptorParamArray;
840
    RealOpenMM nonbondedCutoff;
841
    ReferenceCustomHbondIxn* ixn;
842
    std::vector<std::set<int> > exclusions;
843
    std::vector<std::string> globalParameterNames;
844
845
};

846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
/**
 * This kernel is invoked by CustomCentroidBondForce to calculate the forces acting on the system.
 */
class ReferenceCalcCustomCentroidBondForceKernel : public CalcCustomCentroidBondForceKernel {
public:
    ReferenceCalcCustomCentroidBondForceKernel(std::string name, const Platform& platform) : CalcCustomCentroidBondForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomCentroidBondForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomCentroidBondForce this kernel will be used for
     */
    void initialize(const System& system, const CustomCentroidBondForce& force);
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
     */
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomCentroidBondForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomCentroidBondForce& force);
private:
    int numBonds, numParticles;
    RealOpenMM **bondParamArray;
    ReferenceCustomCentroidBondIxn* ixn;
    std::vector<std::string> globalParameterNames;
};

884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
/**
 * 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);
908
909
910
911
912
913
914
    /**
     * 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);
915
private:
916
    int numBonds;
917
918
919
920
921
    RealOpenMM **bondParamArray;
    ReferenceCustomCompoundBondIxn* ixn;
    std::vector<std::string> globalParameterNames;
};

922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
/**
 * This kernel is invoked by CustomManyParticleForce to calculate the forces acting on the system and the energy of the system.
 */
class ReferenceCalcCustomManyParticleForceKernel : public CalcCustomManyParticleForceKernel {
public:
    ReferenceCalcCustomManyParticleForceKernel(std::string name, const Platform& platform) : CalcCustomManyParticleForceKernel(name, platform), ixn(NULL) {
    }
    ~ReferenceCalcCustomManyParticleForceKernel();
    /**
     * Initialize the kernel.
     *
     * @param system     the System this kernel will be applied to
     * @param force      the CustomManyParticleForce this kernel will be used for
     */
    void initialize(const System& system, const CustomManyParticleForce& force);
    /**
     * Execute the kernel to calculate the forces and/or energy.
     *
     * @param context        the context in which to execute this kernel
     * @param includeForces  true if forces should be calculated
     * @param includeEnergy  true if the energy should be calculated
     * @return the potential energy due to the force
     */
    double execute(ContextImpl& context, bool includeForces, bool includeEnergy);
    /**
     * Copy changed parameters over to a context.
     *
     * @param context    the context to copy parameters to
     * @param force      the CustomManyParticleForce to copy the parameters from
     */
    void copyParametersToContext(ContextImpl& context, const CustomManyParticleForce& force);
private:
    int numParticles;
    RealOpenMM cutoffDistance;
    RealOpenMM **particleParamArray;
    ReferenceCustomManyParticleIxn* ixn;
    std::vector<std::string> globalParameterNames;
    NonbondedMethod nonbondedMethod;
};

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

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

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

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

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

1151
1152
1153
1154
1155
1156
/**
 * 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),
1157
        data(data), dynamics(0) {
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
    }
    ~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);
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
    /**
     * 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);
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
    /**
     * Get the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    on exit, this contains the values
     */
    void getGlobalVariables(ContextImpl& context, std::vector<double>& values) const;
    /**
     * Set the values of all global variables.
     *
     * @param context   the context in which to execute this kernel
     * @param values    a vector containing the values
     */
    void setGlobalVariables(ContextImpl& context, const std::vector<double>& values);
    /**
     * Get the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    on exit, this contains the values
     */
    void getPerDofVariable(ContextImpl& context, int variable, std::vector<Vec3>& values) const;
    /**
     * Set the values of a per-DOF variable.
     *
     * @param context   the context in which to execute this kernel
     * @param variable  the index of the variable to get
     * @param values    a vector containing the values
     */
    void setPerDofVariable(ContextImpl& context, int variable, const std::vector<Vec3>& values);
private:
    ReferencePlatform::PlatformData& data;
    ReferenceCustomDynamics* dynamics;
    std::vector<RealOpenMM> masses, globalValues;
    std::vector<std::vector<OpenMM::RealVec> > perDofValues; 
};

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

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

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

1318
1319
1320
} // namespace OpenMM

#endif /*OPENMM_REFERENCEKERNELS_H_*/