org.jscience.physics.kinematics
Class ParticleHolder

java.lang.Object
  org.jscience.physics.kinematics.ParticleHolder

public class ParticleHolder
extends java.lang.Object

The ParticleHolder class provides a way to hold set of AbstractClassicleParticles that interact with each others. All particles in the Set must have the same dimension.

Constructor Summary

ParticleHolder()
Constructs an Interaction.

ParticleHolder(java.util.Set particles)
Creates a new ParticleHolder object.

Method Summary

void	addParticle(AbstractClassicalParticle p) DOCUMENT ME!
void	addParticles(java.util.Set particles) DOCUMENT ME!
void	buildForces() DOCUMENT ME!
int	getDimension() DOCUMENT ME!
int	getForcesKind() DOCUMENT ME!
int	getNumParticles() DOCUMENT ME!
java.util.Set	getParticles() DOCUMENT ME!
void	removeAllForces() DOCUMENT ME!
void	removeParticle(AbstractClassicalParticle p) DOCUMENT ME!
void	removeParticles(java.util.Set particles) DOCUMENT ME!
void	setForcesKind(int kind) DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticleHolder

public ParticleHolder()

Constructs an Interaction.

ParticleHolder

public ParticleHolder(java.util.Set particles)

Creates a new ParticleHolder object.

Parameters:

particles - DOCUMENT ME!

Throws:

IllegalDimensionException - DOCUMENT ME!

java.lang.IllegalArgumentException - DOCUMENT ME!

Method Detail

getNumParticles

public int getNumParticles()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getDimension

public int getDimension()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getParticles

public java.util.Set getParticles()

DOCUMENT ME!

Returns:

DOCUMENT ME!

addParticle

public void addParticle(AbstractClassicalParticle p)

DOCUMENT ME!

Parameters:

p - DOCUMENT ME!

removeParticle

public void removeParticle(AbstractClassicalParticle p)

DOCUMENT ME!

Parameters:

p - DOCUMENT ME!

addParticles

public void addParticles(java.util.Set particles)

DOCUMENT ME!

Parameters:

particles - DOCUMENT ME!

removeParticles

public void removeParticles(java.util.Set particles)

DOCUMENT ME!

Parameters:

particles - DOCUMENT ME!

getForcesKind

public int getForcesKind()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setForcesKind

public void setForcesKind(int kind)

DOCUMENT ME!

Parameters:

kind - DOCUMENT ME!

removeAllForces

public void removeAllForces()

DOCUMENT ME!

buildForces

public void buildForces()

DOCUMENT ME!