Package etomica.data.meter

Class MeterDipoleSumSquared1site

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.meter.MeterDipoleSumSquared1site

All Implemented Interfaces:

IDataSource

public class MeterDipoleSumSquared1site
extends DataSourceScalar

meter for (sum dipole)^2, used for dielectric constant calculation

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterDipoleSumSquared1site(Space space, Box box, double dipoleMagnitude)

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 _box)

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

MeterDipoleSumSquared1site

public MeterDipoleSumSquared1site(Space space,
                                  Box box,
                                  double dipoleMagnitude)

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

getBox

public Box getBox()

setBox

public void setBox(Box _box)