Package ffx.potential.nonbonded.pme

Enum Class SCFAlgorithm

java.lang.Object

java.lang.Enum<SCFAlgorithm>

ffx.potential.nonbonded.pme.SCFAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SCFAlgorithm>, Constable

public enum SCFAlgorithm
extends Enum<SCFAlgorithm>

Describes available SCF algorithms, and whether they are supported by the FFX and/or CUDA implementations.

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
CG
EPT
SOR

Method Summary

Modifier and Type	Method	Description
boolean	isSupported(Platform platform)	Checks if this platform is supported
static SCFAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SCFAlgorithm[]	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

SOR

public static final SCFAlgorithm SOR

CG

public static final SCFAlgorithm CG

EPT

public static final SCFAlgorithm EPT

Method Details

values

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

isSupported

public boolean isSupported(Platform platform)

Checks if this platform is supported

Parameters:

platform - To check

Returns:

Supported