BrookCalcKineticEnergyKernel.h 3.44 KB
Newer Older
Mark Friedrichs's avatar
Mark Friedrichs committed
1
2
#ifndef OPENMM_BROOK_CALC_KINETIC_ENERGY_KERNEL_H_
#define OPENMM_BROOK_CALC_KINETIC_ENERGY_KERNEL_H_
Mark Friedrichs's avatar
Mark Friedrichs committed
3
4
5
6
7
8
9
10
11

/* -------------------------------------------------------------------------- *
 *                                   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.               *
 *                                                                            *
Mark Friedrichs's avatar
Mark Friedrichs committed
12
 * Portions copyright ( c ) 2008 Stanford University and the Authors.           *
Mark Friedrichs's avatar
Mark Friedrichs committed
13
14
15
16
 * Authors: Peter Eastman, Mark Friedrichs                                    *
 * Contributors:                                                              *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
Mark Friedrichs's avatar
Mark Friedrichs committed
17
 * copy of this software and associated documentation files ( the "Software" ), *
Mark Friedrichs's avatar
Mark Friedrichs committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 * 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.                                     *
 * -------------------------------------------------------------------------- */

Mark Friedrichs's avatar
Mark Friedrichs committed
35
#include "kernels.h"
Mark Friedrichs's avatar
Mark Friedrichs committed
36
37
38
39

namespace OpenMM {

/**
Mark Friedrichs's avatar
Mark Friedrichs committed
40
 * Brook class for calculating kinetic energy
Mark Friedrichs's avatar
Mark Friedrichs committed
41
42
 */

Mark Friedrichs's avatar
Mark Friedrichs committed
43
class BrookCalcKineticEnergyKernel : public CalcKineticEnergyKernel {
44

Mark Friedrichs's avatar
Mark Friedrichs committed
45
   public:
Mark Friedrichs's avatar
Mark Friedrichs committed
46

Mark Friedrichs's avatar
Mark Friedrichs committed
47
48
49
50
51
52
53
54
55
      /**
       * BrookCalcKineticEnergyKernel constructor
       * 
       * @param name        name of the stream to create
       * @param platform    platform
       *
       */
  
      BrookCalcKineticEnergyKernel( std::string name, const Platform& platform );
56

Mark Friedrichs's avatar
Mark Friedrichs committed
57
58
59
60
61
62
      /**
       * BrookCalcKineticEnergyKernel destructor
       * 
       */
  
      ~BrookCalcKineticEnergyKernel();
Mark Friedrichs's avatar
Mark Friedrichs committed
63

Mark Friedrichs's avatar
Mark Friedrichs committed
64
65
66
67
68
69
70
      /** 
       * Initialize the kernel
       * 
       * @param masses   mass of each atom
       *
       */
      void initialize( const std::vector<double>& masses );
Mark Friedrichs's avatar
Mark Friedrichs committed
71

Mark Friedrichs's avatar
Mark Friedrichs committed
72
73
74
75
76
77
78
79
80
81
      /** 
       * Execute the kernel.
       * 
       * @param velocities stream of atom velocities
       *
       */

      double execute( const Stream& velocities );

   private:
82

Mark Friedrichs's avatar
Mark Friedrichs committed
83
84
85
86
};

} // namespace OpenMM

Mark Friedrichs's avatar
Mark Friedrichs committed
87
#endif /* OPENMM_BROOK_CALC_KINETIC_ENERGY_KERNEL_H_ */