Package etomica.liquidLJ

Class PotentialCalculationSumCutoffLS

java.lang.Object

etomica.liquidLJ.PotentialCalculationSumCutoffLS

All Implemented Interfaces:

PotentialCalculation

public class PotentialCalculationSumCutoffLS
extends java.lang.Object
implements PotentialCalculation

Evaluates the energy summed over all iterated atoms. Each call to doCalculate accumulates the energy of the given potential applied to the atoms produced by the given iterator. Each such call accumulates a single sum, which can be accessed via the getSum() method. Sum is re-zeroed only upon a call to the zeroSum() method.

Field Summary

Fields

Modifier and Type	Field	Description
protected double[][]	sums

Constructor Summary

Constructors

Constructor	Description
PotentialCalculationSumCutoffLS()

Method Summary

Modifier and Type	Method	Description
void	doCalculation(IAtomList atoms, IPotentialAtomic potential)	Adds to the energy sum the energy values obtained from application of the given potential to the atoms produced by the given iterator.
double[][]	getSums()	Returns the current value of the energy sum.
void	zeroSums()	Sets the energy sum to zero, typically to begin a new energy-sum calculation.

Methods inherited from class java.lang.Object

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

Field Detail

sums

protected final double[][] sums

Constructor Detail

PotentialCalculationSumCutoffLS

public PotentialCalculationSumCutoffLS()

Method Detail

doCalculation

public void doCalculation(IAtomList atoms,
                          IPotentialAtomic potential)

Adds to the energy sum the energy values obtained from application of the given potential to the atoms produced by the given iterator. Iterator is reset by method before beginning calculation.

Specified by:

doCalculation in interface PotentialCalculation

Parameters:

atoms - IAtomSet the atom sets for which the calculation is performed.

potential - The potential used to apply the action defined by this class.

zeroSums

public void zeroSums()

Sets the energy sum to zero, typically to begin a new energy-sum calculation.

getSums

public double[][] getSums()

Returns the current value of the energy sum.