Package etomica.osmoticvirial

Class PotentialDepletion

java.lang.Object

etomica.potential.Potential

etomica.potential.Potential2

etomica.osmoticvirial.PotentialDepletion

All Implemented Interfaces:

IPotential, IPotentialAtomic, Potential2Spherical

public class PotentialDepletion
extends Potential2
implements Potential2Spherical

Field Summary

Fields

Modifier and Type	Field	Description
protected Boundary	boundary
protected Vector	dr
protected java.lang.String	fileName
protected java.io.FileReader	fileReader
protected java.util.List<double[]>	rwList

Fields inherited from class etomica.potential.Potential

space

Constructor Summary

Constructors

Constructor	Description
PotentialDepletion(Space space, java.lang.String file)

Method Summary

Modifier and Type	Method	Description
double	energy(IAtomList pair)	Returns the interaction energy between the given atoms.
double	getRange()	Returns the range over which the potential applies.
void	setBox(Box box)	Informs the potential of the box on which it acts.
double	u(double r2)	The pair energy u(r^2) with no truncation applied.

Methods inherited from interface etomica.potential.IPotential

nBody

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.potential.Potential

nBody

Field Detail

dr

protected final Vector dr

boundary

protected Boundary boundary

rwList

protected java.util.List<double[]> rwList

fileReader

protected java.io.FileReader fileReader

fileName

protected java.lang.String fileName

Constructor Detail

PotentialDepletion

public PotentialDepletion(Space space,
                          java.lang.String file)

Method Detail

u

public double u(double r2)

Description copied from interface: Potential2Spherical

The pair energy u(r^2) with no truncation applied.

Specified by:

u in interface Potential2Spherical

Parameters:

r2 - the square of the distance between the particles.

energy

public double energy(IAtomList pair)

Description copied from class: Potential

Returns the interaction energy between the given atoms. There might be 0, 1, 2 or more atoms in the AtomSet.

Specified by:

energy in interface IPotentialAtomic

Specified by:

energy in class Potential

getRange

public double getRange()

Description copied from interface: IPotential

Returns the range over which the potential applies. IAtoms with a greater separation do not interact.

Specified by:

getRange in interface IPotential

Specified by:

getRange in class Potential

setBox

public void setBox(Box box)

Description copied from class: Potential

Informs the potential of the box on which it acts. Typically this requires at least that it update the nearestImageTransformer of its coordinatePair (if it uses one), e.g.: cPair.setNearestImageTransformer(box.boundary());

Specified by:

setBox in interface IPotential

Specified by:

setBox in class Potential