All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
AmoebaOutOfPlaneBendForce.h
#ifndef OPENMM_AMOEBA_OUT_OF_PLANE_BEND_FORCE_H_
#define OPENMM_AMOEBA_OUT_OF_PLANE_BEND_FORCE_H_
/* -------------------------------------------------------------------------- *
* OpenMMAmoeba *
* -------------------------------------------------------------------------- *
* 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-2012 Stanford University and the Authors. *
* Authors: Mark Friedrichs, 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. *
* -------------------------------------------------------------------------- */
#include "openmm/Force.h"
#include "internal/windowsExportAmoeba.h"
#include <vector>
namespace OpenMM {
class OPENMM_EXPORT_AMOEBA AmoebaOutOfPlaneBendForce : public Force {
public:
AmoebaOutOfPlaneBendForce();
int getNumOutOfPlaneBends() const {
return outOfPlaneBends.size();
}
void setAmoebaGlobalOutOfPlaneBendCubic(double cubicK);
double getAmoebaGlobalOutOfPlaneBendCubic(void) const;
void setAmoebaGlobalOutOfPlaneBendQuartic(double quarticK);
double getAmoebaGlobalOutOfPlaneBendQuartic(void) const;
void setAmoebaGlobalOutOfPlaneBendPentic(double penticK);
double getAmoebaGlobalOutOfPlaneBendPentic(void) const;
void setAmoebaGlobalOutOfPlaneBendSextic(double sexticK);
double getAmoebaGlobalOutOfPlaneBendSextic(void) const;
int addOutOfPlaneBend(int particle1, int particle2, int particle3, int particle4, double k);
void getOutOfPlaneBendParameters(int index, int& particle1, int& particle2, int& particle3, int& particle4, double& k) const;
void setOutOfPlaneBendParameters(int index, int particle1, int particle2, int particle3, int particle4, double k);
void updateParametersInContext(Context& context);
bool usesPeriodicBoundaryConditions() const {
return false;
}
protected:
ForceImpl* createImpl() const;
double _globalCubicK, _globalQuarticK, _globalPenticK, _globalSexticK;
private:
class OutOfPlaneBendInfo;
std::vector<OutOfPlaneBendInfo> outOfPlaneBends;
};
class AmoebaOutOfPlaneBendForce::OutOfPlaneBendInfo {
public:
int particle1, particle2, particle3, particle4;
double k;
OutOfPlaneBendInfo() {
particle1 = particle2 = particle3 = particle4 = -1;
k = 0.0;
}
OutOfPlaneBendInfo(int particle1, int particle2, int particle3, int particle4,
double k) :
particle1(particle1), particle2(particle2), particle3(particle3), particle4(particle4), k(k) {
}
};
} // namespace OpenMM
#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