Package etomica.potential

Class PotentialArrayByType

java.lang.Object

etomica.potential.PotentialArrayByType

All Implemented Interfaces:

java.io.Serializable

public class PotentialArrayByType
extends java.lang.Object
implements java.io.Serializable

This class stores an array of Potentials and remembers the "other" IAtomType that the IPotential applies to. PotentialMasterMonatomic holds one for each IAtomType and then checks the second IAtomType held by this class to identify the IPotential that applies to any given pair of IAtomTypes. 1-body potentials are stored with a null IAtomType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PotentialArrayByType()

Method Summary

Modifier and Type	Method	Description
int	addPotential(IPotential newPotential, AtomType type)	Identifies the given potential to this type instance and returns the index assigned to it.
int	getPotentialIndex(IPotential potential)	Returns the index that this type has assigned to the given potential.
IPotential[]	getPotentials()
AtomType[]	getTypes()
int	removePotential(IPotential potential)	Removes the given potential and the associated criterion from the list held by this type instance, and returns the index that was assigned to it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PotentialArrayByType

public PotentialArrayByType()

Method Detail

getPotentialIndex

public int getPotentialIndex(IPotential potential)

Returns the index that this type has assigned to the given potential. If potential has not been previously identified to this instance, a new index will be returned.

Parameters:

potential - The potential of interest

Returns:

index associated with potential

addPotential

public int addPotential(IPotential newPotential,
                        AtomType type)

Identifies the given potential to this type instance and returns the index assigned to it. If potential was previously added, no action is taken other than to return the previously assigned index for the potential (acts same as getPotentialIndex in this case).

Parameters:

newPotential - the potential being added

Returns:

the new or previously assigned index for the potential

removePotential

public int removePotential(IPotential potential)

Removes the given potential and the associated criterion from the list held by this type instance, and returns the index that was assigned to it. If the potential was not previously added to this instance, returns -1.

getPotentials

public final IPotential[] getPotentials()

getTypes

public final AtomType[] getTypes()