OpenMM

- Main Page
- Related Pages
- Classes

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Kernel.h
1 #ifndef OPENMM_KERNEL_H_
2 #define OPENMM_KERNEL_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 "KernelImpl.h"
36 #include "openmm/internal/windowsExport.h"
37
38 namespace OpenMM {
39
58 class OPENMM_EXPORT Kernel {
59 public:
60 Kernel();
61 Kernel(const Kernel& copy);
67 Kernel(KernelImpl* impl);
68 ~Kernel();
69 Kernel& operator=(const Kernel& copy);
73 std::string getName() const;
77 const KernelImpl& getImpl() const;
81 KernelImpl& getImpl();
85 template <class T>
86 const T& getAs() const {
87 return dynamic_cast<T&>(*impl);
88 }
92 template <class T>
93 T& getAs() {
94 return dynamic_cast<T&>(*impl);
95 }
96 private:
97 KernelImpl* impl;
98 };
99
100 } // namespace OpenMM
101
102 #endif /*OPENMM_KERNEL_H_*/
OpenMM::KernelImpl
A KernelImpl defines the internal implementation of a Kernel object.
Definition: KernelImpl.h:48
OpenMM::Kernel::getAs
T & getAs()
Get a reference to the object which implements this Kernel, casting it to the specified type...
Definition: Kernel.h:93
OpenMM::Kernel::getAs
const T & getAs() const
Get a reference to the object which implements this Kernel, casting it to the specified type...
Definition: Kernel.h:86
OpenMM::Kernel
A Kernel encapsulates a particular implementation of a calculation that can be performed on the data ...
Definition: Kernel.h:58
OpenMM
Definition: AndersenThermostat.h:40