Package etomica.modules.colloid

Class ColloidSim.CriterionNone

java.lang.Object

etomica.modules.colloid.ColloidSim.CriterionNone

All Implemented Interfaces:

NeighborCriterion

Enclosing class:

ColloidSim

public static class ColloidSim.CriterionNone
extends java.lang.Object
implements NeighborCriterion

Constructor Summary

Constructors

Constructor	Description
CriterionNone()

Method Summary

Modifier and Type	Method	Description
boolean	accept(IAtom atom1, IAtom atom2)
boolean	needUpdate(IAtom atom)	Indicates whether the neighbor list for the given atom should be updated, according to this criterion.
void	reset(IAtom atom)	Indicates to criterion that given atom's neighbor list has just been updated, and that properties (e.g., record of atom's position) used by needUpdate and unsafe() methods should be reset.
void	setBox(Box box)	Specifies the box where the criterion is being applied.
boolean	unsafe()	Indicates whether the atom has changed (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

CriterionNone

public CriterionNone()

Method Detail

unsafe

public boolean unsafe()

Description copied from interface: NeighborCriterion

Indicates whether the atom has changed (e.g. moved) by an amount that might have caused its neighbor list to be invalid. If this method returns true, a neighbor list failure may have introduced errors in the calculation.

Specified by:

unsafe in interface NeighborCriterion

setBox

public void setBox(Box box)

Description copied from interface: NeighborCriterion

Specifies the box where the criterion is being applied. Sometimes needed if the criterion depends on features of the box, such as the boundary.

Specified by:

setBox in interface NeighborCriterion

reset

public void reset(IAtom atom)

Description copied from interface: NeighborCriterion

Indicates to criterion that given atom's neighbor list has just been updated, and that properties (e.g., record of atom's position) used by needUpdate and unsafe() methods should be reset.

Specified by:

reset in interface NeighborCriterion

needUpdate

public boolean needUpdate(IAtom atom)

Description copied from interface: NeighborCriterion

Indicates whether the neighbor list for the given atom should be updated, according to this criterion.

Specified by:

needUpdate in interface NeighborCriterion

Returns:

true if the atom's list should be updated.

accept

public boolean accept(IAtom atom1,
                      IAtom atom2)

Specified by:

accept in interface NeighborCriterion