Package etomica.spin.heisenberg

Class MeterSpinMSquare

java.lang.Object

etomica.data.DataSourceScalar

etomica.spin.heisenberg.MeterSpinMSquare

All Implemented Interfaces:

IDataSource

public class MeterSpinMSquare
extends DataSourceScalar
implements IDataSource

returns the average of square of total dipole moment.

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterSpinMSquare(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 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

MeterSpinMSquare

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

Parameters:

space - , box and 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

Returns:

with M is the total dipole moment;

getBox

public Box getBox()

Returns:

Returns the box.

setBox

public void setBox(Box box)

Parameters:

box - The box to set.