OpenMM

- Main Page
- Related Pages
- Classes

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Platform.h
1 #ifndef OPENMM_PLATFORM_H_
2 #define OPENMM_PLATFORM_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 <map>
36 #include <string>
37 #include <vector>
38 #include "openmm/internal/windowsExport.h"
39
40 namespace OpenMM {
41
42 class Context;
43 class ContextImpl;
44 class Kernel;
45 class KernelFactory;
46
64 class OPENMM_EXPORT Platform {
65 public:
66 virtual ~Platform();
70 virtual const std::string& getName() const = 0;
77 virtual double getSpeed() const = 0;
82 virtual bool supportsDoublePrecision() const = 0;
86 const std::vector<std::string>& getPropertyNames() const;
94 virtual const std::string& getPropertyValue(const Context& context, const std::string& property) const;
102 virtual void setPropertyValue(Context& context, const std::string& property, const std::string& value) const;
110 const std::string& getPropertyDefaultValue(const std::string& property) const;
118 void setPropertyDefaultValue(const std::string& property, const std::string& value);
126 virtual void contextCreated(ContextImpl& context, const std::map<std::string, std::string>& properties) const;
131 virtual void contextDestroyed(ContextImpl& context) const;
140 void registerKernelFactory(const std::string& name, KernelFactory* factory);
148 bool supportsKernels(const std::vector<std::string>& kernelNames) const ;
161 Kernel createKernel(const std::string& name, ContextImpl& context) const;
165 static void registerPlatform(Platform* platform);
169 static int getNumPlatforms();
173 static Platform& getPlatform(int index);
177 static std::vector<std::string> getPluginLoadFailures();
182 static Platform& getPlatformByName(const std::string& name);
190 static Platform& findPlatform(const std::vector<std::string>& kernelNames);
203 static void loadPluginLibrary(const std::string& file);
213 static std::vector<std::string> loadPluginsFromDirectory(const std::string& directory);
221 static const std::string& getDefaultPluginsDirectory();
225 static const std::string& getOpenMMVersion();
226 protected:
230 ContextImpl& getContextImpl(Context& context) const;
234 const ContextImpl& getContextImpl(const Context& context) const;
235 std::vector<std::string> platformProperties;
236 private:
237 std::map<std::string, KernelFactory*> kernelFactories;
238 std::map<std::string, std::string> defaultProperties;
239 static std::vector<Platform*>& getPlatforms();
240 static std::vector<std::string> pluginLoadFailures;
241 };
242
243
244 } // namespace OpenMM
245
246 #endif /*OPENMM_PLATFORM_H_*/
OpenMM::Context
A Context stores the complete state of a simulation.
Definition: Context.h:67
OpenMM::KernelFactory
A KernelFactory is an object that can create KernelImpls.
Definition: KernelFactory.h:45
OpenMM::Kernel
A Kernel encapsulates a particular implementation of a calculation that can be performed on the data ...
Definition: Kernel.h:58
OpenMM::Platform::platformProperties
std::vector< std::string > platformProperties
Definition: Platform.h:235
OpenMM
Definition: AndersenThermostat.h:40
OpenMM::Platform
A Platform defines an implementation of all the kernels needed to perform some calculation.
Definition: Platform.h:64