OpenMM

- Main Page
- Related Pages
- Classes

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
VariableVerletIntegrator.h
1 #ifndef OPENMM_VARIABLEVERLETINTEGRATOR_H_
2 #define OPENMM_VARIABLEVERLETINTEGRATOR_H_
3
4 /* -------------------------------------------------------------------------- *
5 * OpenMM *
6 * -------------------------------------------------------------------------- *
7 * This is part of the OpenMM molecular simulation toolkit originating from *
8 * Simbios, the NIH National Center for Physics-Based Simulation of *
9 * Biological Structures at Stanford, funded under the NIH Roadmap for *
10 * Medical Research, grant U54 GM072970. See https://simtk.org. *
11 * *
12 * Portions copyright (c) 2008-2012 Stanford University and the Authors. *
13 * Authors: Peter Eastman *
14 * Contributors: *
15 * *
16 * Permission is hereby granted, free of charge, to any person obtaining a *
17 * copy of this software and associated documentation files (the "Software"), *
18 * to deal in the Software without restriction, including without limitation *
19 * the rights to use, copy, modify, merge, publish, distribute, sublicense, *
20 * and/or sell copies of the Software, and to permit persons to whom the *
21 * Software is furnished to do so, subject to the following conditions: *
22 * *
23 * The above copyright notice and this permission notice shall be included in *
24 * all copies or substantial portions of the Software. *
25 * *
26 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
27 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
28 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *
29 * THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
30 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
31 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE *
32 * USE OR OTHER DEALINGS IN THE SOFTWARE. *
33 * -------------------------------------------------------------------------- */
34
35 #include "Integrator.h"
36 #include "openmm/Kernel.h"
37 #include "internal/windowsExport.h"
38
39 namespace OpenMM {
40
61 class OPENMM_EXPORT VariableVerletIntegrator : public Integrator {
62 public:
68 explicit VariableVerletIntegrator(double errorTol);
72 double getErrorTolerance() const {
73 return errorTol;
74 }
78 void setErrorTolerance(double tol) {
79 errorTol = tol;
80 }
86 void step(int steps);
95 void stepTo(double time);
96 protected:
102 void initialize(ContextImpl& context);
107 void cleanup();
111 std::vector<std::string> getKernelNames();
115 double computeKineticEnergy();
116 private:
117 double errorTol;
118 Kernel kernel;
119 };
120
121 } // namespace OpenMM
122
123 #endif /*OPENMM_VARIABLEVERLETINTEGRATOR_H_*/
OpenMM::VariableVerletIntegrator::setErrorTolerance
void setErrorTolerance(double tol)
Set the error tolerance.
Definition: VariableVerletIntegrator.h:78
OpenMM::VariableVerletIntegrator::getErrorTolerance
double getErrorTolerance() const
Get the error tolerance.
Definition: VariableVerletIntegrator.h:72
OpenMM::Integrator
An Integrator defines a method for simulating a System by integrating the equations of motion...
Definition: Integrator.h:54
OpenMM::Kernel
A Kernel encapsulates a particular implementation of a calculation that can be performed on the data ...
Definition: Kernel.h:58
OpenMM::VariableVerletIntegrator
This is an error contolled, variable time step Integrator that simulates a System using the leap-frog...
Definition: VariableVerletIntegrator.h:61
OpenMM
Definition: AndersenThermostat.h:40