Package ffx.potential

Enum Class ForceFieldEnergy.Platform

java.lang.Object

java.lang.Enum<ForceFieldEnergy.Platform>

ffx.potential.ForceFieldEnergy.Platform

All Implemented Interfaces:

Serializable, Comparable<ForceFieldEnergy.Platform>, Constable

Enclosing class:

ForceFieldEnergy

public static enum ForceFieldEnergy.Platform
extends Enum<ForceFieldEnergy.Platform>

Platform describes a set of force field implementations that include a pure Java reference implementation (FFX), and two OpenMM implementations (OMM_CUDA and OMM_REF are supported)

FFX: reference FFX implementation

OMM: Currently an alias for OMM_CUDA, may eventually become "try to find best OpenMM implementation" OMM_CUDA:

OpenMM CUDA implementation OMM_REF: OpenMM reference implementation

OMM_OPTCPU: Optimized OpenMM CPU implementation (no AMOEBA)

OMM_OPENCL: OpenMM OpenCL implementation (no AMOEBA)

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
OMM
OMM_CUDA
OMM_OPENCL
OMM_OPTCPU
OMM_REF

Method Summary

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

OMM

public static final ForceFieldEnergy.Platform OMM

OMM_CUDA

public static final ForceFieldEnergy.Platform OMM_CUDA

OMM_REF

public static final ForceFieldEnergy.Platform OMM_REF

OMM_OPTCPU

public static final ForceFieldEnergy.Platform OMM_OPTCPU

OMM_OPENCL

public static final ForceFieldEnergy.Platform OMM_OPENCL

Method Details

values

public static ForceFieldEnergy.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 ForceFieldEnergy.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