Package etomica.data.meter

Class MeterKineticEnergy

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.meter.MeterKineticEnergy

All Implemented Interfaces:

IDataSource

public class MeterKineticEnergy
extends DataSourceScalar

Meter for the total kinetic energy in a box Computes total KE by summing values of KE returned by every atom in the box. A different box-dependent atom integrator may be set to permit calculation over a particular set of atoms in the box.

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterKineticEnergy(Box box)
MeterKineticEnergy(Box box, AtomIteratorBoxDependent iterator)

Method Summary

Modifier and Type	Method	Description
Box	getBox()
double	getDataAsScalar()	Returns the total kinetic energy summed over all atoms produced by the iterator when applied to the given box.
AtomIteratorBoxDependent	getIterator()	Returns the iterator that defines the atoms summed for their kinetic energy.

Methods inherited from class etomica.data.DataSourceScalar

getData, getDataDouble, getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Constructor Detail

MeterKineticEnergy

public MeterKineticEnergy(Box box,
                          AtomIteratorBoxDependent iterator)

MeterKineticEnergy

public MeterKineticEnergy(Box box)

Method Detail

getIterator

public AtomIteratorBoxDependent getIterator()

Returns the iterator that defines the atoms summed for their kinetic energy.

getDataAsScalar

public double getDataAsScalar()

Returns the total kinetic energy summed over all atoms produced by the iterator when applied to the given box. Does not include contributions from atoms having infinite mass (it assumes they are stationary).

Specified by:

getDataAsScalar in class DataSourceScalar

getBox

public Box getBox()

Returns:

Returns the box.