Package ffx.numerics.multipole

Enum Class GKSource.GK_MULTIPOLE_ORDER

java.lang.Object

java.lang.Enum<GKSource.GK_MULTIPOLE_ORDER>

ffx.numerics.multipole.GKSource.GK_MULTIPOLE_ORDER

All Implemented Interfaces:

Serializable, Comparable<GKSource.GK_MULTIPOLE_ORDER>, Constable

Enclosing class:

GKSource

public static enum GKSource.GK_MULTIPOLE_ORDER
extends Enum<GKSource.GK_MULTIPOLE_ORDER>

The GK tensor can be constructed for a monopole potential (GB), a dipole potential or a quadrupole potential.

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
DIPOLE
MONOPOLE
QUADRUPOLE

Method Summary

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

MONOPOLE

public static final GKSource.GK_MULTIPOLE_ORDER MONOPOLE

DIPOLE

public static final GKSource.GK_MULTIPOLE_ORDER DIPOLE

QUADRUPOLE

public static final GKSource.GK_MULTIPOLE_ORDER QUADRUPOLE

Method Details

values

public static GKSource.GK_MULTIPOLE_ORDER[] 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 GKSource.GK_MULTIPOLE_ORDER 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

getOrder

public int getOrder()