Package etomica.nbr.molecule

Class CriterionSpeciesPair

java.lang.Object

etomica.nbr.molecule.CriterionAdapterMolecular

etomica.nbr.molecule.CriterionSpeciesPair

All Implemented Interfaces:

NeighborCriterionMolecular

public class CriterionSpeciesPair
extends CriterionAdapterMolecular

Filters molecule pairs to match a given pair of Species.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.nbr.molecule.CriterionAdapterMolecular

subCriterion

Constructor Summary

Constructors

Constructor	Description
CriterionSpeciesPair(NeighborCriterionMolecular criterion, ISpecies species0, ISpecies species1)

Method Summary

Modifier and Type	Method	Description
boolean	accept(IMoleculeList pair)	Returns true if the Species for the pair of molecules match the Species given at construction (without regard to the order of the pair), and if the wrapped criterion also accepts the pair.
ISpecies[]	getSpecies()	Returns the Species accepted by this NeighborCriterionMolecular

Methods inherited from class etomica.nbr.molecule.CriterionAdapterMolecular

getWrappedCriterion, needUpdate, reset, setBox, unsafe

Methods inherited from class java.lang.Object

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

Constructor Detail

CriterionSpeciesPair

public CriterionSpeciesPair(NeighborCriterionMolecular criterion,
                            ISpecies species0,
                            ISpecies species1)

Method Detail

accept

public boolean accept(IMoleculeList pair)

Returns true if the Species for the pair of molecules match the Species given at construction (without regard to the order of the pair), and if the wrapped criterion also accepts the pair.

Specified by:

accept in interface NeighborCriterionMolecular

Specified by:

accept in class CriterionAdapterMolecular

getSpecies

public ISpecies[] getSpecies()

Returns the Species accepted by this NeighborCriterionMolecular