Package ffx.numerics.multipole

Enum Class Operator

java.lang.Object

java.lang.Enum<Operator>

ffx.numerics.multipole.Operator

All Implemented Interfaces:

Serializable, Comparable<Operator>, Constable

public enum Operator
extends Enum<Operator>

Operators that are supported.

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
AMOEBA_PLUS_DAMP_FIELD	Charge-Penetration nucleus-multipole operator.
AMOEBA_PLUS_OVERLAP_FIELD	Mpole-Mpole Interaction for Amoeba+
AMOEBA_PLUS_SYM_DAMP_FIELD	Core-Mpole Interaction with 2 identical atoms
COULOMB	Coulomb operator.
SCREENED_COULOMB	Screened Coulomb operator.
THOLE_DIRECT_FIELD	IndDipole-Mpole Interaction for Amoeba+
THOLE_FIELD	Thole field operator.

Method Summary

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

COULOMB

public static final Operator COULOMB

Coulomb operator.

SCREENED_COULOMB

public static final Operator SCREENED_COULOMB

Screened Coulomb operator.

AMOEBA_PLUS_DAMP_FIELD

public static final Operator AMOEBA_PLUS_DAMP_FIELD

Charge-Penetration nucleus-multipole operator.

AMOEBA_PLUS_OVERLAP_FIELD

public static final Operator AMOEBA_PLUS_OVERLAP_FIELD

Mpole-Mpole Interaction for Amoeba+

THOLE_DIRECT_FIELD

public static final Operator THOLE_DIRECT_FIELD

IndDipole-Mpole Interaction for Amoeba+

AMOEBA_PLUS_SYM_DAMP_FIELD

public static final Operator AMOEBA_PLUS_SYM_DAMP_FIELD

Core-Mpole Interaction with 2 identical atoms

THOLE_FIELD

public static final Operator THOLE_FIELD

Thole field operator.

Method Details

values

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