Package ffx.numerics.multipole

Enum Class GKMultipoleOrder

java.lang.Object

java.lang.Enum<GKMultipoleOrder>

ffx.numerics.multipole.GKMultipoleOrder

All Implemented Interfaces:

Serializable, Comparable<GKMultipoleOrder>, Constable

public enum GKMultipoleOrder
extends Enum<GKMultipoleOrder>

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	Dipole potential.
MONOPOLE	Monopole potential.
QUADRUPOLE	Quadrupole potential.

Method Summary

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

Monopole potential.

DIPOLE

public static final GKMultipoleOrder DIPOLE

Dipole potential.

QUADRUPOLE

public static final GKMultipoleOrder QUADRUPOLE

Quadrupole potential.

Method Details

values

public static GKMultipoleOrder[] 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 GKMultipoleOrder 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()

Return the multipole order.

Returns:

Returns the multipole order.