OpenMM

- Main Page
- Related Pages
- Classes

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
AmoebaOutOfPlaneBendForce.h
1 #ifndef OPENMM_AMOEBA_OUT_OF_PLANE_BEND_FORCE_H_
2 #define OPENMM_AMOEBA_OUT_OF_PLANE_BEND_FORCE_H_
3
4 /* -------------------------------------------------------------------------- *
5 * OpenMMAmoeba *
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: Mark Friedrichs, 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 "openmm/Force.h"
36 #include "internal/windowsExportAmoeba.h"
37 #include <vector>
38
39 namespace OpenMM {
40
49 class OPENMM_EXPORT_AMOEBA AmoebaOutOfPlaneBendForce : public Force {
50
51 public:
52
56 AmoebaOutOfPlaneBendForce();
57
61 int getNumOutOfPlaneBends() const {
62 return outOfPlaneBends.size();
63 }
64
70 void setAmoebaGlobalOutOfPlaneBendCubic(double cubicK);
71
77 double getAmoebaGlobalOutOfPlaneBendCubic(void) const;
78
84 void setAmoebaGlobalOutOfPlaneBendQuartic(double quarticK);
85
91 double getAmoebaGlobalOutOfPlaneBendQuartic(void) const;
92
98 void setAmoebaGlobalOutOfPlaneBendPentic(double penticK);
99
105 double getAmoebaGlobalOutOfPlaneBendPentic(void) const;
106
112 void setAmoebaGlobalOutOfPlaneBendSextic(double sexticK);
113
119 double getAmoebaGlobalOutOfPlaneBendSextic(void) const;
120
131 int addOutOfPlaneBend(int particle1, int particle2, int particle3, int particle4, double k);
132
143 void getOutOfPlaneBendParameters(int index, int& particle1, int& particle2, int& particle3, int& particle4, double& k) const;
144
155 void setOutOfPlaneBendParameters(int index, int particle1, int particle2, int particle3, int particle4, double k);
165 void updateParametersInContext(Context& context);
172 bool usesPeriodicBoundaryConditions() const {
173 return false;
174 }
175 protected:
176 ForceImpl* createImpl() const;
177 double _globalCubicK, _globalQuarticK, _globalPenticK, _globalSexticK;
178 private:
179 class OutOfPlaneBendInfo;
180 std::vector<OutOfPlaneBendInfo> outOfPlaneBends;
181 };
182
187 class AmoebaOutOfPlaneBendForce::OutOfPlaneBendInfo {
188 public:
189 int particle1, particle2, particle3, particle4;
190 double k;
191 OutOfPlaneBendInfo() {
192 particle1 = particle2 = particle3 = particle4 = -1;
193 k = 0.0;
194 }
195 OutOfPlaneBendInfo(int particle1, int particle2, int particle3, int particle4,
196 double k) :
197 particle1(particle1), particle2(particle2), particle3(particle3), particle4(particle4), k(k) {
198
199 }
200 };
201
202 } // namespace OpenMM
203
204 #endif /*OPENMM_AMOEBA_OUT_OF_PLANE_BEND_FORCE_H_*/
OpenMM::Context
A Context stores the complete state of a simulation.
Definition: Context.h:67
OpenMM::AmoebaOutOfPlaneBendForce::usesPeriodicBoundaryConditions
bool usesPeriodicBoundaryConditions() const
Returns whether or not this force makes use of periodic boundary conditions.
Definition: AmoebaOutOfPlaneBendForce.h:172
OpenMM::AmoebaOutOfPlaneBendForce::getNumOutOfPlaneBends
int getNumOutOfPlaneBends() const
Get the number of out-of-plane bend terms in the potential function.
Definition: AmoebaOutOfPlaneBendForce.h:61
OpenMM::Force
Force objects apply forces to the particles in a System, or alter their behavior in other ways...
Definition: Force.h:65
OpenMM::AmoebaOutOfPlaneBendForce
This class implements the Amoeba out-of-plane bend interaction.
Definition: AmoebaOutOfPlaneBendForce.h:49
OpenMM
Definition: AndersenThermostat.h:40
OpenMM::AmoebaOutOfPlaneBendForce::_globalSexticK
double _globalSexticK
Definition: AmoebaOutOfPlaneBendForce.h:177