BrookStochasticDynamics.cpp 25.5 KB
Newer Older
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/* -------------------------------------------------------------------------- *
 *                                   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.               *
 *                                                                            *
 * Portions copyright (c) 2008 Stanford University and the Authors.           *
 * Authors: Mark Friedrichs                                                   *
 * 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.                                     *
 * -------------------------------------------------------------------------- */

#include <sstream>
#include "BrookStochasticDynamics.h"
#include "BrookPlatform.h"
#include "OpenMMException.h"
#include "BrookStreamImpl.h"

// use random number generator

#include "SimTKOpenMMUtilities.h"

using namespace OpenMM;
using namespace std;

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
46
 *
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
47
48
49
50
 * Constructor
 * 
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
51
BrookStochasticDynamics::BrookStochasticDynamics( ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
52
53
54
55

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookStochasticDynamics::BrookStochasticDynamics";
Mark Friedrichs's avatar
Mark Friedrichs committed
56
57
58
59

   BrookOpenMMFloat zero                    = (BrookOpenMMFloat)  0.0;
   BrookOpenMMFloat one                     = (BrookOpenMMFloat)  1.0;
   BrookOpenMMFloat oneMinus                = (BrookOpenMMFloat) -1.0;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
60
61
62

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
63
64
65
66
   _numberOfAtoms             = -1;

   // mark stream dimension variables as unset

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
67
68
69
70
71
72
73
74
   _sdAtomStreamWidth         = -1;
   _sdAtomStreamHeight        = -1;
   _sdAtomStreamSize          = -1;

   for( int ii = 0; ii < LastStreamIndex; ii++ ){
      _sdStreams[ii]   = NULL;
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
75
76
   for( int ii = 0; ii < MaxDerivedParameters; ii++ ){
      _derivedParameters[ii]   = oneMinus;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
77
78
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
79
   _temperature = _stepSize = _tau = oneMinus;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
80

Mark Friedrichs's avatar
Mark Friedrichs committed
81
82
83
84
85
86
87
88
   // setup inverse sqrt masses

   _inverseSqrtMasses = NULL;

   // set randomNumber seed 

   //_randomNumberSeed = randomNumberSeed ? randomNumberSeed : 1393;
   //SimTKOpenMMUtilities::setRandomNumberSeed( randomNumberSeed );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
}   
 
/** 
 * Destructor
 * 
 */

BrookStochasticDynamics::~BrookStochasticDynamics( ){

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookStochasticDynamics::~BrookStochasticDynamics";

// ---------------------------------------------------------------------------------------

   for( int ii = 0; ii < LastStreamIndex; ii++ ){
      delete _sdStreams[ii];
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
108
   delete[] _inverseSqrtMasses;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
109
110
111
112

}

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
113
 * Get tau
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
114
 * 
Mark Friedrichs's avatar
Mark Friedrichs committed
115
 * @return  tau
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
116
117
118
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
119
120
121
BrookOpenMMFloat BrookStochasticDynamics::getTau( void ) const {
   return _tau;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
122

Mark Friedrichs's avatar
Mark Friedrichs committed
123
124
125
126
127
128
/** 
 * Get temperature
 * 
 * @return  temperature
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
129

Mark Friedrichs's avatar
Mark Friedrichs committed
130
131
132
BrookOpenMMFloat BrookStochasticDynamics::getTemperature( void ) const {
   return _temperature;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
133

Mark Friedrichs's avatar
Mark Friedrichs committed
134
135
136
137
138
139
/** 
 * Get stepSize
 * 
 * @return  stepSize
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
140

Mark Friedrichs's avatar
Mark Friedrichs committed
141
142
143
BrookOpenMMFloat BrookStochasticDynamics::getStepSize( void ) const {
   return _stepSize;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
144

Mark Friedrichs's avatar
Mark Friedrichs committed
145
146
147
148
149
150
151
152
/** 
 * Set tau
 * 
 * @param tau   new tau value
 *
 * @return      DefaultReturn
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
153

Mark Friedrichs's avatar
Mark Friedrichs committed
154
155
156
157
int BrookStochasticDynamics::_setTau( BrookOpenMMFloat tau ){
   _tau = tau;
   return DefaultReturn;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
158

Mark Friedrichs's avatar
Mark Friedrichs committed
159
160
161
162
163
164
165
166
/** 
 * Set friction = 1/tau
 * 
 * @param friction   new friction value
 *
 * @return      DefaultReturn
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
167

Mark Friedrichs's avatar
Mark Friedrichs committed
168
169
170
171
int BrookStochasticDynamics::_setFriction( BrookOpenMMFloat friction ){
   _tau   = (BrookOpenMMFloat) ( (friction != 0.0) ? 1.0/friction : 0.0);
   return DefaultReturn;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
172

Mark Friedrichs's avatar
Mark Friedrichs committed
173
174
175
176
177
178
179
180
/** 
 * Set temperature
 * 
 * @parameter   temperature
 *
 * @return      DefaultReturn
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
181

Mark Friedrichs's avatar
Mark Friedrichs committed
182
183
int BrookStochasticDynamics::_setTemperature( BrookOpenMMFloat temperature ){
   _temperature = temperature;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
184
   return DefaultReturn;
Mark Friedrichs's avatar
Mark Friedrichs committed
185
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
186

Mark Friedrichs's avatar
Mark Friedrichs committed
187
188
189
190
191
192
193
194
/** 
 * Set stepSize
 * 
 * @param   stepSize
 *
 * @return      DefaultReturn
 *
 */
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
195

Mark Friedrichs's avatar
Mark Friedrichs committed
196
197
198
199
int BrookStochasticDynamics::_setStepSize( BrookOpenMMFloat stepSize ){
   _stepSize = stepSize;
   return DefaultReturn;
}
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
200
201

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
202
 * Update derived parameters
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
203
204
205
206
207
 * 
 * @return  DefaultReturn
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
208
int BrookStochasticDynamics::_updateDerivedParameters( void ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
209
210
211

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
212
   // static const char* methodName = "\nBrookStochasticDynamics::_updateDerivedParameters";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
213
214
215
216
217
218
219
220
221
222

   static const BrookOpenMMFloat zero       =  0.0;
   static const BrookOpenMMFloat one        =  1.0;
   static const BrookOpenMMFloat two        =  2.0;
   static const BrookOpenMMFloat three      =  3.0;
   static const BrookOpenMMFloat four       =  4.0;
   static const BrookOpenMMFloat half       =  0.5;

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
   BrookOpenMMFloat tau         = getTau();
   BrookOpenMMFloat temperature = getTemperature();
   BrookOpenMMFloat stepSize    = getStepSize();

   _derivedParameters[GDT]      = stepSize/tau;

   _derivedParameters[EPH]      = EXP(  half*_derivedParameters[GDT] );
   _derivedParameters[EMH]      = EXP( -half*_derivedParameters[GDT] );
   _derivedParameters[EM]       = EXP(      -_derivedParameters[GDT] );
   _derivedParameters[EP]       = EXP(       _derivedParameters[GDT] );

   if( _derivedParameters[GDT] >= (BrookOpenMMFloat) 0.1 ){

      BrookOpenMMFloat term1    = _derivedParameters[EPH] - one;
                 term1         *= term1;
      _derivedParameters[B]     = _derivedParameters[GDT]*(_derivedParameters[EP] - one) - four*term1;

      _derivedParameters[C]     = _derivedParameters[GDT] - three + four*_derivedParameters[EMH] - _derivedParameters[EM];
      _derivedParameters[D]     = two - _derivedParameters[EPH] - _derivedParameters[EMH];

    } else {

      BrookOpenMMFloat term1        = half*_derivedParameters[GDT];
      BrookOpenMMFloat term2        = term1*term1;
      BrookOpenMMFloat term4        = term2*term2;

      BrookOpenMMFloat third        = (BrookOpenMMFloat) ( 1.0/3.0 );
      BrookOpenMMFloat o7_9         = (BrookOpenMMFloat) ( 7.0/9.0 );
      BrookOpenMMFloat o1_12        = (BrookOpenMMFloat) ( 1.0/12.0 );
      BrookOpenMMFloat o17_90       = (BrookOpenMMFloat) ( 17.0/90.0 );
      BrookOpenMMFloat o7_30        = (BrookOpenMMFloat) ( 7.0/30.0 );
      BrookOpenMMFloat o31_1260     = (BrookOpenMMFloat) ( 31.0/1260.0 );
      BrookOpenMMFloat o_360        = (BrookOpenMMFloat) ( 1.0/360.0 );

      _derivedParameters[B]         = term4*( third  + term1*( third + term1*( o17_90 + term1*o7_9 )));
      _derivedParameters[C]         = term2*term1*( two*third + term1*( -half + term1*( o7_30 + term1*(-o1_12 + term1*o31_1260 ))));
      _derivedParameters[D]         = term2*( -one + term2*(-o1_12 - term2*o_360));
   }    

   BrookOpenMMFloat kT        = ((BrookOpenMMFloat) BOLTZ)*temperature;

   _derivedParameters[V]      = SQRT( kT*( one - _derivedParameters[EM]) );
   _derivedParameters[X]      = tau*SQRT( kT*_derivedParameters[C] );
   _derivedParameters[Yv]     = SQRT( kT*_derivedParameters[B]/_derivedParameters[C] );
   _derivedParameters[Yx]     = tau*SQRT( kT*_derivedParameters[B]/(one - _derivedParameters[EM]) );

   _derivedParameters[Sd1pc1] = tau*( one - _derivedParameters[EM] );
   _derivedParameters[Sd1pc2] = tau*( _derivedParameters[EPH] - _derivedParameters[EMH] );
   _derivedParameters[Sd1pc3] = _derivedParameters[D]/(tau*_derivedParameters[C] );
   _derivedParameters[Sd2pc1] = one/_derivedParameters[Sd1pc2];
   _derivedParameters[Sd2pc2] = tau*_derivedParameters[D]/( _derivedParameters[EM] - one );
       
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
275
276
277
278
279
   return DefaultReturn;

};

/** 
Mark Friedrichs's avatar
Mark Friedrichs committed
280
 * Update parameters -- only way parameters can be set
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
281
282
283
 * 
 * @param  temperature     temperature
 * @param  friction        friction
Mark Friedrichs's avatar
Mark Friedrichs committed
284
 * @param  step size       step size
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
285
286
287
288
289
290
291
292
293
294
295
296
297
 *
 * @return   solute dielectric
 *
 */

int BrookStochasticDynamics::updateParameters( double temperature, double friction, double stepSize ){

   // ---------------------------------------------------------------------------------------

   // static const char* methodName = "\nBrookStochasticDynamics::updateParameters";

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
298
299
300
   _setStepSize( stepSize );
   _setFriction( friction );
   _setTemperature( temperature );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
301

Mark Friedrichs's avatar
Mark Friedrichs committed
302
   _updateDerivedParameters( );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
303
304
305
306
307
308
309
310
   _updateSdStreams( );

   return DefaultReturn;

};

/**---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
311
   Get array of derived parameters indexed by 'DerivedParameters' enums
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
312
313
314
315
316

   @return array

   --------------------------------------------------------------------------------------- */
   
Mark Friedrichs's avatar
Mark Friedrichs committed
317
const BrookOpenMMFloat* BrookStochasticDynamics::getDerivedParameters( void ) const {
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
318
319
320

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
321
   // static const char* methodName  = "\nBrookStochasticDynamics::getDerivedParameters";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
322
323
324

   // ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
325
   return _derivedParameters;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
}

/** 
 * Get Atom stream size
 *
 * @return  Atom stream size
 *
 */

int BrookStochasticDynamics::getStochasticDynamicsAtomStreamSize( void ) const {
   return _sdAtomStreamSize;
}

/** 
 * Get atom stream width
 *
 * @return  atom stream width
 *
 */

int BrookStochasticDynamics::getStochasticDynamicsAtomStreamWidth( void ) const {
   return _sdAtomStreamWidth;
}

/** 
 * Get atom stream height
 *
 * @return atom stream height
 */

int BrookStochasticDynamics::getStochasticDynamicsAtomStreamHeight( void ) const {
   return _sdAtomStreamHeight;
}

/** 
 * Get SDPC1 stream 
 *
 * @return  SDPC1 stream
 *
 */

BrookFloatStreamInternal* BrookStochasticDynamics::getSDPC1( void ) const {
   return _sdStreams[SDPC1Stream];
}

/** 
 * Get SDPC2 stream 
 *
 * @return  SDPC2 stream
 *
 */

BrookFloatStreamInternal* BrookStochasticDynamics::getSDPC2( void ) const {
   return _sdStreams[SDPC2Stream];
}

/** 
 * Get SD2X stream 
 *
 * @return  SD2X stream
 *
 */

BrookFloatStreamInternal* BrookStochasticDynamics::getSD2X( void ) const {
   return _sdStreams[SD2XStream];
}

/** 
 * Get SD1V stream 
 *
 * @return  SD1V stream
 *
 */

BrookFloatStreamInternal* BrookStochasticDynamics::getSD1V( void ) const {
   return _sdStreams[SD1VStream];
}

/** 
 * Initialize stream dimensions
 * 
 * @param numberOfAtoms             number of atoms
 * @param platform                  platform
 *
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
414
int BrookStochasticDynamics::_initializeStreamSizes( int numberOfAtoms, const Platform& platform ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
415
416
417

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
418
   //static const std::string methodName      = "BrookStochasticDynamics::_initializeStreamSizes";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
419
420
421
422
423
424
425
426
427
428

// ---------------------------------------------------------------------------------------

   _sdAtomStreamSize     = getAtomStreamSize( platform );
   _sdAtomStreamWidth    = getAtomStreamWidth( platform );
   _sdAtomStreamHeight   = getAtomStreamHeight( platform );

   return DefaultReturnValue;
}

Mark Friedrichs's avatar
Mark Friedrichs committed
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
/** 
 * Initialize stream dimensions
 * 
 * @param numberOfAtoms             number of atoms
 * @param platform                  platform
 *
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

std::string BrookStochasticDynamics::_getDerivedParametersString( BrookStochasticDynamics::DerivedParameters  derivedParametersIndex ) const {

// ---------------------------------------------------------------------------------------

   //static const std::string methodName      = "BrookStochasticDynamics::_getDerivedParametersString";

// ---------------------------------------------------------------------------------------

   std::string returnString;
 
   switch( derivedParametersIndex ){
 
      case GDT:
         returnString = "GDT";
         break;
 
      case EPH:
         returnString = "EPH";
         break;
 
      case EMH:
         returnString = "EMH";
         break;
 
      case EP:
         returnString = "EP";
         break;
 
      case EM:
         returnString = "EM";
         break;
 
      case B:
         returnString = "B";
         break;
 
      case C:
         returnString = "C";
         break;
 
      case D:
         returnString = "D";
         break;
 
      case V:
         returnString = "V";
         break;
 
      case X:
         returnString = "X";
         break;
 
      case Yv:
         returnString = "Yv";
         break;
 
      case Yx:
         returnString = "Yx";
         break;
 
      case Sd1pc1:
         returnString = "Sd1pc1";
         break;
 
      case Sd1pc2:
         returnString = "Sd1pc2";
         break;
 
      case Sd1pc3:
         returnString = "Sd1pc3";
         break;
 
      case Sd2pc1:
         returnString = "Sd2pc1";
         break;
 
      case Sd2pc2:
         returnString = "Sd2pc2";
         break;
 
      default:
         returnString = "Unknown";
         break;
    }
 
    return returnString;
}

Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
527
528
529
530
531
532
533
534
535
/** 
 * Initialize streams
 * 
 * @param platform                  platform
 *
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
536
int BrookStochasticDynamics::_initializeStreams( const Platform& platform ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
537
538
539

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
540
   //static const std::string methodName      = "BrookStochasticDynamics::_initializeStreams";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
541
542
543

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
544
545
   int sdAtomStreamSize             = getStochasticDynamicsAtomStreamSize();
   int sdAtomStreamWidth            = getStochasticDynamicsAtomStreamWidth();
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
546

Mark Friedrichs's avatar
Mark Friedrichs committed
547
548
549
    _sdStreams[SDPC1Stream]         = new BrookFloatStreamInternal( BrookCommon::SDPC1Stream,
                                                                    sdAtomStreamSize, sdAtomStreamWidth,
                                                                    BrookStreamInternal::Float2, dangleValue );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
550

Mark Friedrichs's avatar
Mark Friedrichs committed
551
552
553
    _sdStreams[SDPC2Stream]         = new BrookFloatStreamInternal( BrookCommon::SDPC2Stream,
                                                                    sdAtomStreamSize, sdAtomStreamWidth,
                                                                    BrookStreamInternal::Float2, dangleValue );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
554

Mark Friedrichs's avatar
Mark Friedrichs committed
555
556
557
    _sdStreams[SD2XStream]          = new BrookFloatStreamInternal( BrookCommon::SD2XStream,
                                                                    sdAtomStreamSize, sdAtomStreamWidth,
                                                                    BrookStreamInternal::Float3, dangleValue );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
558

Mark Friedrichs's avatar
Mark Friedrichs committed
559
560
561
    _sdStreams[SD1VStream]          = new BrookFloatStreamInternal( BrookCommon::SD1VStream,
                                                                    sdAtomStreamSize, sdAtomStreamWidth,
                                                                    BrookStreamInternal::Float3, dangleValue );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576

   return DefaultReturnValue;
}

/** 
 * Update sd streams -- called after parameters change
 * 
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 */

int BrookStochasticDynamics::_updateSdStreams( void ){

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
577
   static const std::string methodName      = "BrookStochasticDynamics::_updateSdStreams";
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
578
579
580
581
582
583
584
585
586
587
588

// ---------------------------------------------------------------------------------------

   int sdAtomStreamSize          = getStochasticDynamicsAtomStreamSize();

   BrookOpenMMFloat sdpc[2];
   for( int ii = 0; ii < 2; ii++ ){
      sdpc[ii] = new BrookOpenMMFloat[2*sdAtomStreamSize];
      memset( sdpc[ii], 0, 2*sdAtomStreamSize*sizeof( BrookOpenMMFloat ) ); 
   }

Mark Friedrichs's avatar
Mark Friedrichs committed
589
590
591
   const BrookOpenMMFloat* derivedParameters = getDerivedParameters( );
   int numberOfAtoms                   = getNumberOfAtoms();
   int index                           = 0;
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
592
593
   for( int ii = 0; ii < numberOfAtoms; ii++ ){

Mark Friedrichs's avatar
Mark Friedrichs committed
594
595
      sdpc[0][index]      = _inverseSqrtMasses[ii]*( static_cast<BrookOpenMMFloat> (derivedParameters[Yv]) );
      sdpc[0][index+1]    = _inverseSqrtMasses[ii]*( static_cast<BrookOpenMMFloat> (derivedParameters[V])  );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
596

Mark Friedrichs's avatar
Mark Friedrichs committed
597
598
      sdpc[1][index]      = _inverseSqrtMasses[ii]*( static_cast<BrookOpenMMFloat> (derivedParameters[Yx]) );
      sdpc[1][index+1]    = _inverseSqrtMasses[ii]*( static_cast<BrookOpenMMFloat> (derivedParameters[X])  );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617

      index              += 2;
   }

   _sdStreams[SDPC1Stream]->loadFromArray( sdpc[0] );
   _sdStreams[SDPC2Stream]->loadFromArray( sdpc[1] );

   for( int ii = 0; ii < 2; ii++ ){
      delete[] sdpc[ii];
   }

   // initialize SD2X

   sd2x = new BrookOpenMMFloat[3*sdAtomStreamSize];
   SimTKOpenMMUtilities::setRandomNumberSeed( (uint32_t) getRandomNumberSeed() );

   memset( sd2x, 0, 3*sdAtomStreamSize*sizeof( BrookOpenMMFloat ) ); 

   for( int ii = 0; ii < numberOfAtoms; ii++ ){
Mark Friedrichs's avatar
Mark Friedrichs committed
618
619
620
      sd2x[index]        = _inverseSqrtMasses[ii]*derivedParameters[X]*( static_cast<BrookOpenMMFloat> (SimTKOpenMMUtilities::getNormallyDistributedRandomNumber()) );
      sd2x[index+1]      = _inverseSqrtMasses[ii]*derivedParameters[X]*( static_cast<BrookOpenMMFloat> (SimTKOpenMMUtilities::getNormallyDistributedRandomNumber()) );
      sd2x[index+2]      = _inverseSqrtMasses[ii]*derivedParameters[X]*( static_cast<BrookOpenMMFloat> (SimTKOpenMMUtilities::getNormallyDistributedRandomNumber()) );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
621
622
623
624
625
626
627
628
629
630
   }
   
   _sdStreams[SD2XStream]->loadFromArray( sd2x );

   delete[] sd2x;

   return DefaultReturnValue;

}

Mark Friedrichs's avatar
Mark Friedrichs committed
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
/** 
 * Set masses 
 * 
 * @param masses             atomic masses
 *
 */

int BrookStochasticDynamics::_setInverseSqrtMasses( const std::vector<double>& masses ){

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookStochasticDynamics::_setInverseSqrtMasses";

// ---------------------------------------------------------------------------------------

   // setup inverse sqrt masses

   _inverseSqrtMasses = new BrookOpenMMFloat[masses.size()];
   int index          = 0;
   for( std::vector<double>::const_interator ii = masses.begin(); ii != masses.end(); ii++, index++ ){
      if( *ii != 0.0 ){
         _inverseSqrtMasses[index] = ( SQRT( one/(*ii) ) );
      } else {
         _inverseSqrtMasses[index] = zero;
      }
   }

   return DefaultReturnValue;
}   
 
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
661
662
663
/*  
 * Setup of StochasticDynamics parameters
 *
Mark Friedrichs's avatar
Mark Friedrichs committed
664
 * @param masses                masses
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
665
666
667
668
669
670
 * @param platform              Brook platform
 *
 * @return nonzero value if error
 *
 * */
    
Mark Friedrichs's avatar
Mark Friedrichs committed
671
int BrookStochasticDynamics::setup( const std::vector<<double> >& masses, const Platform& platform ){
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
672
673
674
675
676
677
678
    
// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookStochasticDynamics::setup";

// ---------------------------------------------------------------------------------------

Mark Friedrichs's avatar
Mark Friedrichs committed
679
   int numberOfAtoms  = (int) masses.size();
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
680
681
   setNumberOfAtoms( numberOfAtoms );

Mark Friedrichs's avatar
Mark Friedrichs committed
682
   _setInverseSqrtMasses( masses );
Mark Friedrichs's avatar
Mods  
Mark Friedrichs committed
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832

   return DefaultReturnValue;
}

/* 
 * Setup of stream dimensions for partial force streams
 *
 * @param atomStreamSize        atom stream size
 * @param atomStreamWidth       atom stream width
 *
 * @return ErrorReturnValue if error, else DefaultReturnValue
 *
 * */

int BrookStochasticDynamics::initializePartialForceStreamSize( int atomStreamSize, int atomStreamWidth ){

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookStochasticDynamics::initializePartialForceStreamSize";
   //static const int debug                   = 1;

// ---------------------------------------------------------------------------------------

   int innerUnroll           = getInnerLoopUnroll();
   if( innerUnroll < 1 ){
      std::stringstream message;
      message << methodName << " innerUnrolls=" << innerUnroll << " is less than 1.";
      throw OpenMMException( message.str() );
      return ErrorReturnValue;
   }

   if( _partialForceStreamWidth < 1 ){
      std::stringstream message;
      message << methodName << " partial force stream width=" << _partialForceStreamWidth << " is less than 1.";
      throw OpenMMException( message.str() );
      return ErrorReturnValue;
   }

   _partialForceStreamSize    = atomStreamSize*getDuplicationFactor()/innerUnroll;
   _partialForceStreamHeight  = _partialForceStreamSize/_partialForceStreamWidth;
   _partialForceStreamHeight += ( (_partialForceStreamSize % _partialForceStreamWidth) ? 1 : 0);

   return DefaultReturnValue;
}

/* 
 * Setup of j-stream dimensions
 * 
 * Get contents of object
 *
 *
 * @param level   level of dump
 *
 * @return string containing contents
 *
 * */

std::string BrookStochasticDynamics::getContentsString( int level ) const {

// ---------------------------------------------------------------------------------------

   static const std::string methodName      = "BrookStochasticDynamics::getContentsString";

   static const unsigned int MAX_LINE_CHARS = 256;
   char value[MAX_LINE_CHARS];
   static const char* Set                   = "Set";
   static const char* NotSet                = "Not set";

// ---------------------------------------------------------------------------------------

   std::stringstream message;
   std::string tab   = "   ";

#ifdef WIN32
#define LOCAL_SPRINTF(a,b,c) sprintf_s( (a), MAX_LINE_CHARS, (b), (c) );   
#else
#define LOCAL_SPRINTF(a,b,c) sprintf( (a), (b), (c) );   
#endif

   (void) LOCAL_SPRINTF( value, "%d", getNumberOfAtoms() );
   message << _getLine( tab, "Number of atoms:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getNumberOfForceStreams() );
   message << _getLine( tab, "Number of force streams:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getDuplicationFactor() );
   message << _getLine( tab, "Duplication factor:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getInnerLoopUnroll () )
   message << _getLine( tab, "Inner loop unroll:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getOuterLoopUnroll() )
   message << _getLine( tab, "Outer loop unroll:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getAtomSizeCeiling() );
   message << _getLine( tab, "Atom ceiling:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getAtomStreamWidth() );
   message << _getLine( tab, "Atom stream width:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getAtomStreamHeight() );
   message << _getLine( tab, "Atom stream height:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getAtomStreamSize() );
   message << _getLine( tab, "Atom stream size:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getPartialForceStreamWidth() );
   message << _getLine( tab, "Partial force stream width:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getPartialForceStreamHeight() );
   message << _getLine( tab, "Partial force stream height:", value ); 

   (void) LOCAL_SPRINTF( value, "%d", getPartialForceStreamSize() );
   message << _getLine( tab, "Partial force stream size:", value ); 

   message << _getLine( tab, "Log:",                  (getLog()                ? Set : NotSet) ); 
/*
   message << _getLine( tab, "ExclusionStream:",      (getExclusionStream()    ? Set : NotSet) ); 
   message << _getLine( tab, "VdwStream:",            (getOuterVdwStream()     ? Set : NotSet) ); 
   message << _getLine( tab, "ChargeStream:",         (getChargeStream()       ? Set : NotSet) ); 
   message << _getLine( tab, "SigmaStream:",          (getInnerSigmaStream()   ? Set : NotSet) ); 
   message << _getLine( tab, "EpsilonStream:",        (getInnerEpsilonStream() ? Set : NotSet) ); 
*/
 
   for( int ii = 0; ii < LastStreamIndex; ii++ ){
      message << std::endl;
      if( _sdStreams[ii] ){
         message << _sdStreams[ii]->getContentsString( );
      }
   }

   // force streams

   for( int ii = 0; ii < getNumberOfForceStreams(); ii++ ){
      char description[256];
      (void) LOCAL_SPRINTF( description, "PartialForceStream %d", ii );
      message << _getLine( tab, description,  (isForceStreamSet(ii) ? Set : NotSet) ); 
   }
 
   for( int ii = 0; ii < getNumberOfForceStreams(); ii++ ){
      message << std::endl;
      if( _sdForceStreams[ii] ){
         message << _sdForceStreams[ii]->getContentsString( );
      }
   }

#undef LOCAL_SPRINTF

   return message.str();
}