OpenMM
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
CustomHbondForceImpl.h
1 #ifndef OPENMM_CUSTOMHBONDFORCEIMPL_H_
2 #define OPENMM_CUSTOMHBONDFORCEIMPL_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-2010 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 "ForceImpl.h"
36 #include "openmm/CustomHbondForce.h"
37 #include "openmm/Kernel.h"
38 #include "lepton/CustomFunction.h"
39 #include "lepton/ExpressionTreeNode.h"
40 #include "lepton/ParsedExpression.h"
41 #include <utility>
42 #include <map>
43 #include <string>
44 
45 namespace OpenMM {
46 
51 class OPENMM_EXPORT CustomHbondForceImpl : public ForceImpl {
52 public:
55  void initialize(ContextImpl& context);
56  const CustomHbondForce& getOwner() const {
57  return owner;
58  }
60  // This force field doesn't update the state directly.
61  }
62  double calcForcesAndEnergy(ContextImpl& context, bool includeForces, bool includeEnergy, int groups);
63  std::map<std::string, double> getDefaultParameters();
64  std::vector<std::string> getKernelNames();
65  void updateParametersInContext(ContextImpl& context);
81  static Lepton::ParsedExpression prepareExpression(const CustomHbondForce& force, const std::map<std::string, Lepton::CustomFunction*>& functions, std::map<std::string, std::vector<int> >& distances,
82  std::map<std::string, std::vector<int> >& angles, std::map<std::string, std::vector<int> >& dihedrals);
83 private:
84  class FunctionPlaceholder;
85  static Lepton::ExpressionTreeNode replaceFunctions(const Lepton::ExpressionTreeNode& node, std::map<std::string, int> atoms,
86  std::map<std::string, std::vector<int> >& distances, std::map<std::string, std::vector<int> >& angles,
87  std::map<std::string, std::vector<int> >& dihedrals);
88  const CustomHbondForce& owner;
89  Kernel kernel;
90 };
91 
92 } // namespace OpenMM
93 
94 #endif /*OPENMM_CUSTOMHBONDFORCEIMPL_H_*/
This is the internal implementation of a Context.
Definition: ContextImpl.h:53
const CustomHbondForce & getOwner() const
Get the Force object from which this ForceImpl was created.
Definition: CustomHbondForceImpl.h:56
This class supports a wide variety of energy functions used to represent hydrogen bonding...
Definition: CustomHbondForce.h:98
This is the internal implementation of CustomHbondForce.
Definition: CustomHbondForceImpl.h:51
void updateContextState(ContextImpl &context)
This method is called at the beginning of each time step.
Definition: CustomHbondForceImpl.h:59
A Kernel encapsulates a particular implementation of a calculation that can be performed on the data ...
Definition: Kernel.h:58
A ForceImpl provides the internal implementation of a Force.
Definition: ForceImpl.h:57