Package etomica.potential

Class P3BondAngle

java.lang.Object

etomica.potential.Potential

etomica.potential.P3BondAngle

All Implemented Interfaces:

IPotential, IPotentialAtomic, PotentialSoft

public class P3BondAngle
extends Potential
implements PotentialSoft

Simple 3-body soft bond-angle potential

Field Summary

Fields

Modifier and Type	Field	Description
protected double	angle
protected Boundary	boundary
protected Vector	dr12
protected Vector	dr23
protected double	epsilon
protected Vector[]	gradient

Fields inherited from class etomica.potential.Potential

space

Constructor Summary

Constructors

Constructor	Description
P3BondAngle(Space space)

Method Summary

Modifier and Type	Method	Description
double	energy(IAtomList atomSet)	Returns the interaction energy between the given atoms.
double	getAngle()	Returns the nominal bond angle (in radians)
Dimension	getAngleDimension()
double	getEpsilon()	Returns the characteristic energy of the potential
Dimension	getEpsilonDimension()
double	getRange()	Returns the range over which the potential applies.
Vector[]	gradient(IAtomList atoms)	Returns the gradient of the potential as it applies to each atom in the given AtomSet, indicating how the energy would change as the position of the first atom is varied.
Vector[]	gradient(IAtomList atoms, Tensor pressureTensor)	Returns the same gradient as gradient(AtomSet) and also adds in the contribution of the AtomSet to the pressureTensor.
static void	main(java.lang.String[] args)
void	setAngle(double newAngle)	Sets the nominal bond angle (in radians)
void	setBox(Box box)	Informs the potential of the box on which it acts.
void	setEpsilon(double newEpsilon)	Sets the characteristic energy of the potential
double	virial(IAtomList atoms)

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

dr12

protected final Vector dr12

dr23

protected final Vector dr23

boundary

protected Boundary boundary

angle

protected double angle

epsilon

protected double epsilon

gradient

protected final Vector[] gradient

Constructor Detail

P3BondAngle

public P3BondAngle(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

energy

public double energy(IAtomList atomSet)

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

setAngle

public void setAngle(double newAngle)

Sets the nominal bond angle (in radians)

getAngle

public double getAngle()

Returns the nominal bond angle (in radians)

getAngleDimension

public Dimension getAngleDimension()

setEpsilon

public void setEpsilon(double newEpsilon)

Sets the characteristic energy of the potential

getEpsilon

public double getEpsilon()

Returns the characteristic energy of the potential

getEpsilonDimension

public Dimension getEpsilonDimension()

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

gradient

public Vector[] gradient(IAtomList atoms)

Description copied from interface: PotentialSoft

Returns the gradient of the potential as it applies to each atom in the given AtomSet, indicating how the energy would change as the position of the first atom is varied. The method is allowed to return an array of Vectors with fewer elements than the number of atoms in the AtomSet.

Specified by:

gradient in interface PotentialSoft

Returns:

gradient

public Vector[] gradient(IAtomList atoms,
                         Tensor pressureTensor)

Description copied from interface: PotentialSoft

Returns the same gradient as gradient(AtomSet) and also adds in the contribution of the AtomSet to the pressureTensor. Their contribution is added to the given Tensor. This combined method exists for computational efficiency. Calculating the pressureTensor is generally trivial once the gradient is known but often requires intermediate information.

Specified by:

gradient in interface PotentialSoft

virial

public double virial(IAtomList atoms)

Specified by:

virial in interface PotentialSoft

main

public static void main(java.lang.String[] args)