Package etomica.potential

Class Potential1

java.lang.Object

etomica.potential.Potential

etomica.potential.Potential1

All Implemented Interfaces:

IPotential, IPotentialAtomic

Direct Known Subclasses:

P1Constraint, P1HardMovingBoundary, P1HardPeriodic, P1HardWall, P1Harmonic, P1HarmonicSite, P1ImageHarmonic, P1LepsHarmonic, P1MagicWall, P1MagneticField, P1SoftBoundary, P1Tether, P1Wall, P1WCAPorousWall, P1WCAWall, P1WCAWall, P1WCAWall

public abstract class Potential1
extends Potential

Potential acting on a single atom or atom group.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Potential1.Intramolecular	Marker interface indicating that a one-body potential is an intramolecular potential, and not, e.g., a potential of interaction with an external field.

Field Summary

Fields

Modifier and Type	Field	Description
protected Boundary	boundary

Fields inherited from class etomica.potential.Potential

space

Constructor Summary

Constructors

Constructor	Description
Potential1(Space space)

Method Summary

Modifier and Type	Method	Description
double	getRange()	Returns zero.
void	setBox(Box box)	Informs the potential of the box on which it acts.

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

energy, nBody

Field Detail

boundary

protected Boundary boundary

Constructor Detail

Potential1

public Potential1(Space space)

Method Detail

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

getRange

public double getRange()

Returns zero.

Specified by:

getRange in interface IPotential

Specified by:

getRange in class Potential