Package etomica.spin.ising

Class MeterSpin

java.lang.Object

etomica.data.DataSourceScalar

etomica.spin.ising.MeterSpin

All Implemented Interfaces:

IDataSource

public class MeterSpin
extends DataSourceScalar
implements IDataSource

Meter that provides the x-component of the vector average of spin values (which is represented by the atom's position vector).

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterSpin(Space space)

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 interface etomica.data.IDataSource

getData, getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Constructor Detail

MeterSpin

public MeterSpin(Space space)

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

Returns:

Returns the box.

setBox

public void setBox(Box box)

Parameters:

box - The box to set.