kineticMonteCarlo.atom

Interface IAtom

All Known Implementing Classes:

AbstractAtom, AbstractGrowthAtom, AgAtom, AgAtomSimple, BasicAtom, BasicGrowthAtom, BasicGrowthSimpleAtom, CatalysisAtom, ConcertedAtom, GrapheneAtom, GrapheneAtomGaillard, GrapheneAtomGaillard1Neighbour, GrapheneAtomGaillardSimple, GrapheneAtomSchoenhalz, SiAtom

public interface IAtom

This interface defines the minimum methods that an atom class have to have.

Author:

J. Alberdi-Rodriguez

Method Summary

Modifier and Type	Method and Description
int	getNumberOfNeighbours()
Point3D	getPos()
double[]	getProbabilities()
double	getProbability()
byte	getRealType()
byte	getType()
boolean	isEligible()
boolean	isOccupied()
boolean	isOnList()
boolean	isRemoved()
double	remove()
void	setList(java.lang.Boolean list)
void	setNeighbour(AbstractAtom atom, int i)
void	setNumberOfNeighbours(int numberOfNeighbours)
void	setProbabilities(double[] probabilities)
void	setRemoved()
void	unRemove()

Method Detail

setProbabilities

void setProbabilities(double[] probabilities)

getProbabilities

double[] getProbabilities()

setList

void setList(java.lang.Boolean list)

isOnList

boolean isOnList()

getProbability

double getProbability()

isEligible

boolean isEligible()

isRemoved

boolean isRemoved()

isOccupied

boolean isOccupied()

unRemove

void unRemove()

setRemoved

void setRemoved()

remove

double remove()

getType

byte getType()

getRealType

byte getRealType()

getNumberOfNeighbours

int getNumberOfNeighbours()

setNumberOfNeighbours

void setNumberOfNeighbours(int numberOfNeighbours)

setNeighbour

void setNeighbour(AbstractAtom atom,
                  int i)

getPos

Point3D getPos()