Package ffx.algorithms.dynamics.integrators

Enum Class IntegratorEnum

java.lang.Object

java.lang.Enum<IntegratorEnum>

ffx.algorithms.dynamics.integrators.IntegratorEnum

All Implemented Interfaces:

Serializable, Comparable<IntegratorEnum>, Constable

public enum IntegratorEnum
extends Enum<IntegratorEnum>

An enumeration of available integrators.

Author:

Michael J. Schnieders

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
BEEMAN
LANGEVIN
LANGEVIN_MTS
MTS
RESPA
STOCHASTIC
STOCHASTIC_MTS
VELOCITY_VERLET
VERLET

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	deterministic
final boolean	reversible

Method Summary

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

BEEMAN

public static final IntegratorEnum BEEMAN

STOCHASTIC

public static final IntegratorEnum STOCHASTIC

LANGEVIN

public static final IntegratorEnum LANGEVIN

VERLET

public static final IntegratorEnum VERLET

VELOCITY_VERLET

public static final IntegratorEnum VELOCITY_VERLET

MTS

public static final IntegratorEnum MTS

RESPA

public static final IntegratorEnum RESPA

STOCHASTIC_MTS

public static final IntegratorEnum STOCHASTIC_MTS

LANGEVIN_MTS

public static final IntegratorEnum LANGEVIN_MTS

Field Details

reversible

public final boolean reversible

deterministic

public final boolean deterministic

Method Details

values

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

isStochastic

public static boolean isStochastic(IntegratorEnum integrator)