All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Platform.h
#ifndef OPENMM_PLATFORM_H_
#define OPENMM_PLATFORM_H_
/* -------------------------------------------------------------------------- *
* OpenMM *
* -------------------------------------------------------------------------- *
* 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: 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 <map>
#include <string>
#include <vector>
#include "openmm/internal/windowsExport.h"
namespace OpenMM {
class Context;
class ContextImpl;
class Kernel;
class KernelFactory;
class OPENMM_EXPORT Platform {
public:
virtual ~Platform();
virtual const std::string& getName() const = 0;
virtual double getSpeed() const = 0;
virtual bool supportsDoublePrecision() const = 0;
const std::vector<std::string>& getPropertyNames() const;
virtual const std::string& getPropertyValue(const Context& context, const std::string& property) const;
virtual void setPropertyValue(Context& context, const std::string& property, const std::string& value) const;
const std::string& getPropertyDefaultValue(const std::string& property) const;
void setPropertyDefaultValue(const std::string& property, const std::string& value);
virtual void contextCreated(ContextImpl& context, const std::map<std::string, std::string>& properties) const;
virtual void contextDestroyed(ContextImpl& context) const;
void registerKernelFactory(const std::string& name, KernelFactory* factory);
bool supportsKernels(const std::vector<std::string>& kernelNames) const ;
Kernel createKernel(const std::string& name, ContextImpl& context) const;
static void registerPlatform(Platform* platform);
static int getNumPlatforms();
static Platform& getPlatform(int index);
static std::vector<std::string> getPluginLoadFailures();
static Platform& getPlatformByName(const std::string& name);
static Platform& findPlatform(const std::vector<std::string>& kernelNames);
static void loadPluginLibrary(const std::string& file);
static std::vector<std::string> loadPluginsFromDirectory(const std::string& directory);
static const std::string& getDefaultPluginsDirectory();
static const std::string& getOpenMMVersion();
protected:
ContextImpl& getContextImpl(Context& context) const;
const ContextImpl& getContextImpl(const Context& context) const;
std::vector<std::string> platformProperties;
private:
std::map<std::string, KernelFactory*> kernelFactories;
std::map<std::string, std::string> defaultProperties;
static std::vector<Platform*>& getPlatforms();
static std::vector<std::string> pluginLoadFailures;
};
} // namespace OpenMM
#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