Package ffx.algorithms.optimize

Enum Class Minimize.MinimizationEngine

java.lang.Object

java.lang.Enum<Minimize.MinimizationEngine>

ffx.algorithms.optimize.Minimize.MinimizationEngine

All Implemented Interfaces:

Serializable, Comparable<Minimize.MinimizationEngine>, Constable

Enclosing class:

Minimize

public static enum Minimize.MinimizationEngine
extends Enum<Minimize.MinimizationEngine>

Enumerates available molecular minimization engines; presently limited to the FFX reference engine and the OpenMM engine.

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FFX
OPENMM

Method Summary

Modifier and Type	Method	Description
EnumSet<Platform>	getSupportedPlatforms()	Gets the set of Platforms supported by this DynamicsEngine
boolean	supportsPlatform(Platform platform)	Checks if this energy Platform is supported by this DynamicsEngine
static Minimize.MinimizationEngine	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Minimize.MinimizationEngine[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FFX

public static final Minimize.MinimizationEngine FFX

OPENMM

public static final Minimize.MinimizationEngine OPENMM

Method Details

values

public static Minimize.MinimizationEngine[] 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 Minimize.MinimizationEngine 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

getSupportedPlatforms

public EnumSet<Platform> getSupportedPlatforms()

Gets the set of Platforms supported by this DynamicsEngine

Returns:

An EnumSet

supportsPlatform

public boolean supportsPlatform(Platform platform)

Checks if this energy Platform is supported by this DynamicsEngine

Parameters:

platform - The requested platform.

Returns:

If supported