Package ffx.numerics.multipole

Enum Class GKTensorMode

java.lang.Object

java.lang.Enum<GKTensorMode>

ffx.numerics.multipole.GKTensorMode

All Implemented Interfaces:

Serializable, Comparable<GKTensorMode>, Constable

public enum GKTensorMode
extends Enum<GKTensorMode>

The "mode" for the tensor (either POTENTIAL or BORN).

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
BORN	The tensor is for the GK Born-chain rule.
POTENTIAL	The tensor is for the GK potential energy.

Method Summary

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

POTENTIAL

public static final GKTensorMode POTENTIAL

The tensor is for the GK potential energy.

BORN

public static final GKTensorMode BORN

The tensor is for the GK Born-chain rule.

Method Details

values

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