Package etomica.potential

Class PotentialArray

java.lang.Object

etomica.potential.PotentialArray

All Implemented Interfaces:

java.io.Serializable

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

Instances of this class are created by AtomType classes to store the list of potentials and criteria that apply to the atoms of that type.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PotentialArray()

Method Summary

Modifier and Type	Method	Description
int	addPotential(IPotential newPotential)	Identifies the given potential to this type instance and returns the index assigned to it.
NeighborCriterion[]	getCriteria()
int	getPotentialIndex(IPotential potential)	Returns the index that this type has assigned to the given potential.
IPotential[]	getPotentials()
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.
void	setCriterion(IPotential potential, NeighborCriterion criterion)	Sets the criterion associated with the given potential

Methods inherited from class java.lang.Object

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

Constructor Detail

PotentialArray

public PotentialArray()

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)

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

setCriterion

public void setCriterion(IPotential potential,
                         NeighborCriterion criterion)

Sets the criterion associated with the given 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()

getCriteria

public final NeighborCriterion[] getCriteria()