OpenMM
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
AmoebaGeneralizedKirkwoodForceImpl.h
1 #ifndef OPENMM_AMOEBA_GK_FORCE_FIELD_IMPL_H_
2 #define OPENMM_AMOEBA_GK_FORCE_FIELD_IMPL_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 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 "openmm/internal/ForceImpl.h"
36 #include "openmm/AmoebaGeneralizedKirkwoodForce.h"
37 #include "openmm/Kernel.h"
38 #include <string>
39 
40 namespace OpenMM {
41 
47 public:
49  void initialize(ContextImpl& context);
51  return owner;
52  }
54  // This force field doesn't update the state directly.
55  }
56  double calcForcesAndEnergy(ContextImpl& context, bool includeForces, bool includeEnergy, int groups);
57  std::map<std::string, double> getDefaultParameters() {
58  return std::map<std::string, double>(); // This force field doesn't define any parameters.
59  }
60  std::vector<std::string> getKernelNames();
62  return kernel;
63  }
65 private:
66  const AmoebaGeneralizedKirkwoodForce& owner;
67  Kernel kernel;
68 };
69 
70 } // namespace OpenMM
71 
72 #endif /*OPENMM_AMOEBA_GBSA_OBC_FORCE_FIELD_IMPL_H_*/
This is the internal implementation of a Context.
Definition: ContextImpl.h:53
double calcForcesAndEnergy(ContextImpl &context, bool includeForces, bool includeEnergy, int groups)
Calculate the force on each particle generated by this ForceImpl and/or this ForceImpl&#39;s contribution...
Kernel & getKernel()
Definition: AmoebaGeneralizedKirkwoodForceImpl.h:61
void updateContextState(ContextImpl &context)
This method is called at the beginning of each time step.
Definition: AmoebaGeneralizedKirkwoodForceImpl.h:53
const AmoebaGeneralizedKirkwoodForce & getOwner() const
Get the Force object from which this ForceImpl was created.
Definition: AmoebaGeneralizedKirkwoodForceImpl.h:50
AmoebaGeneralizedKirkwoodForceImpl(const AmoebaGeneralizedKirkwoodForce &owner)
This is the internal implementation of AmoebaGeneralizedKirkwoodForce.
Definition: AmoebaGeneralizedKirkwoodForceImpl.h:46
This class implements an implicit solvation force using the generalized Kirkwood/Grycuk model...
Definition: AmoebaGeneralizedKirkwoodForce.h:52
std::vector< std::string > getKernelNames()
Get the names of all Kernels used by this Force.
void initialize(ContextImpl &context)
This is called after the ForceImpl is created and before updateContextState(), calcForces(), or calcEnergy() is called on it.
A Kernel encapsulates a particular implementation of a calculation that can be performed on the data ...
Definition: Kernel.h:58
void updateParametersInContext(ContextImpl &context)
A ForceImpl provides the internal implementation of a Force.
Definition: ForceImpl.h:57
std::map< std::string, double > getDefaultParameters()
Get a map containing the default values for all adjustable parameters defined by this ForceImpl...
Definition: AmoebaGeneralizedKirkwoodForceImpl.h:57