Package etomica.potential

Class P1ExternalField

java.lang.Object

etomica.potential.PotentialMolecular

etomica.potential.P1ExternalField

All Implemented Interfaces:

IPotential, IPotentialMolecular

public class P1ExternalField
extends PotentialMolecular

Field Summary

Fields

Modifier and Type	Field	Description
protected DipoleSource	dipoleSource
protected Vector	externalField

Fields inherited from class etomica.potential.PotentialMolecular

nBody, space

Constructor Summary

Constructors

Constructor	Description
P1ExternalField(Space space)

Method Summary

Modifier and Type	Method	Description
double	energy(IMoleculeList molecules)	Returns the interaction energy between the given molecules.
double	getRange()	Returns the range over which the potential applies.
void	setBox(Box box)	Informs the potential of the box on which it acts.
void	setDipoleSource(DipoleSource newDipoleSource)
void	setExternalField(Vector newExternalField)

Methods inherited from class java.lang.Object

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

Methods inherited from class etomica.potential.PotentialMolecular

nBody

Field Detail

dipoleSource

protected DipoleSource dipoleSource

externalField

protected Vector externalField

Constructor Detail

P1ExternalField

public P1ExternalField(Space space)

Method Detail

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 PotentialMolecular

setExternalField

public void setExternalField(Vector newExternalField)

energy

public double energy(IMoleculeList molecules)

Description copied from class: PotentialMolecular

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

Specified by:

energy in interface IPotentialMolecular

Specified by:

energy in class PotentialMolecular

setBox

public void setBox(Box box)

Description copied from class: PotentialMolecular

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 PotentialMolecular

setDipoleSource

public void setDipoleSource(DipoleSource newDipoleSource)