Package etomica.data.meter

Class MeterEnergy

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.meter.MeterEnergy

All Implemented Interfaces:

IDataSource

public final class MeterEnergy
extends DataSourceScalar

Meter for measurement of the total (potential and kinetic) energy in a box This meter is constructed from kinetic-energy and a potential-energy meters An instance of this meter is placed in each box to allow for energy measurements in the box

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSourceScalar	kinetic
protected DataSourceScalar	potential

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterEnergy(PotentialMaster potentialMaster, Box box)

Method Summary

Modifier and Type	Method	Description
double	getDataAsScalar()	Current value of the total energy (kinetic + potential)
DataSourceScalar	getKinetic()
double	getKineticEnergy()
DataSourceScalar	getPotential()
double	getPotentialEnergy()
void	setKinetic(DataSourceScalar kinetic)
void	setPotential(DataSourceScalar potential)

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

Field Detail

kinetic

protected DataSourceScalar kinetic

potential

protected DataSourceScalar potential

Constructor Detail

MeterEnergy

public MeterEnergy(PotentialMaster potentialMaster,
                   Box box)

Method Detail

getKinetic

public DataSourceScalar getKinetic()

setKinetic

public void setKinetic(DataSourceScalar kinetic)

getPotential

public DataSourceScalar getPotential()

setPotential

public void setPotential(DataSourceScalar potential)

getKineticEnergy

public double getKineticEnergy()

Returns:

the current value of the total kinetic energy of the molecules in the box

getPotentialEnergy

public double getPotentialEnergy()

Returns:

the current value of the total potential energy of the molecules in the box

getDataAsScalar

public double getDataAsScalar()

Current value of the total energy (kinetic + potential)

Specified by:

getDataAsScalar in class DataSourceScalar