Package ffx.potential

Enum Class Platform

java.lang.Object

java.lang.Enum<Platform>

ffx.potential.Platform

All Implemented Interfaces:

Serializable, Comparable<Platform>, Constable

public enum Platform
extends Enum<Platform>

Platform describes a set of force field implementations that include a pure Java reference implementation (FFX), and OpenMM implementations (Reference, CUDA and OpenCL).

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	Reference FFX implementation.
OMM	An alias for the best GPU implementation (OMM_CUDA or OMM_OPENCL).
OMM_CPU	Optimized OpenMM CPU implementation (no AMOEBA support).
OMM_CUDA	OpenMM CUDA implementation.
OMM_OPENCL	OpenMM OpenCL implementation.
OMM_REF	OpenMM reference implementation.

Method Summary

Modifier and Type	Method	Description
static Platform	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Platform[]	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 Platform FFX

Reference FFX implementation.

OMM

public static final Platform OMM

An alias for the best GPU implementation (OMM_CUDA or OMM_OPENCL).

OMM_CUDA

public static final Platform OMM_CUDA

OpenMM CUDA implementation.

OMM_REF

public static final Platform OMM_REF

OpenMM reference implementation.

OMM_OPENCL

public static final Platform OMM_OPENCL

OpenMM OpenCL implementation.

OMM_CPU

public static final Platform OMM_CPU

Optimized OpenMM CPU implementation (no AMOEBA support).

Method Details

values

public static Platform[] 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 Platform 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