Package etomica.normalmode

Class MeterAPIPotentialEnergy

java.lang.Object

etomica.data.DataSourceScalar

etomica.normalmode.MeterAPIPotentialEnergy

All Implemented Interfaces:

IDataSource

public class MeterAPIPotentialEnergy
extends DataSourceScalar

Meter that returns the potential energy using an IAPIPotential.

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected IAPIPotential	potential

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterAPIPotentialEnergy(IAPIPotential potential)

Method Summary

Modifier and Type	Method	Description
Box	getBox()
double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.
void	setBox(Box newBox)

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

potential

protected final IAPIPotential potential

box

protected Box box

Constructor Detail

MeterAPIPotentialEnergy

public MeterAPIPotentialEnergy(IAPIPotential potential)

Method Detail

getDataAsScalar

public double getDataAsScalar()

Description copied from class: DataSourceScalar

Returns a single scalar value as the measurement for the given box. Subclasses define this method to specify the measurement they make.

Specified by:

getDataAsScalar in class DataSourceScalar

setBox

public void setBox(Box newBox)

getBox

public Box getBox()