Package ffx.openmm

Class Platform

java.lang.Object
ffx.openmm.Platform
public class Platform extends Object
A Platform defines an implementation of all the kernels needed to perform some calculation. More precisely, a Platform object acts as a registry for a set of KernelFactory objects which together implement the kernels. The Platform class, in turn, provides a static registry of all available Platform objects.

  • Constructor Details

    • Platform

      public Platform(String platformName)
      OpenMM Platform constructor.
      Parameters:
      platformName - The name of the OpenMM Platform.

  • Method Details

    • getPointer

      public com.sun.jna.ptr.PointerByReference getPointer()
      Get the OpenMM Platform pointer.
      Returns:
      The OpenMM Platform pointer.

    • getName

      public String getName()
      Get the name of the OpenMM Platform.
      Returns:
      The name of the OpenMM Platform.

    • getSpeed

      public double getSpeed()
      Get an estimate of how fast this Platform class is.
      Returns:
      The speed of the OpenMM Platform.

    • setPropertyDefaultValue

      public void setPropertyDefaultValue(String propertyName, String defaultValue)
      Set an OpenMM Platform property.

    • getNumPlatforms

      public static int getNumPlatforms()
      Get the number of OpenMM Platforms.
      Returns:
      The number of OpenMM Platforms.

    • getOpenMMVersion

      public static String getOpenMMVersion()
      Get the OpenMM version.
      Returns:
      The version of OpenMM.

    • loadPluginsFromDirectory

      public static StringArray loadPluginsFromDirectory(String directory)
      Load plugins from a directory.
      Parameters:
      directory - The directory to load plugins from.
      Returns:
      The OpenMMStringArray of plugins loaded.

    • getPluginLoadFailures

      public static StringArray getPluginLoadFailures()
      Get the plugin load failures.
      Returns:
      The OpenMMStringArray of plugin load failures.

    • destroy

      public void destroy()
      Destroy the OpenMM Platform instance.