Enum Class MDEngine

java.lang.Object
java.lang.Enum<MDEngine>
ffx.algorithms.dynamics.MDEngine
All Implemented Interfaces:
Serializable, Comparable<MDEngine>, Constable

public enum MDEngine extends Enum<MDEngine>
Enumerates available molecular dynamics engines; presently limited to the FFX reference engine and the OpenMM engine.

This is distinct from the force field energy Platform, as the FFX engine can use OpenMM energies, but not vice-versa.

  • Enum Constant Details

    • FFX

      public static final MDEngine FFX
    • OMM

      public static final MDEngine OMM
    • OPENMM

      public static final MDEngine OPENMM
  • Method Details

    • values

      public static MDEngine[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static MDEngine valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null