Package etomica.spin.heisenberg

Class MeterDipoleMoment

java.lang.Object

etomica.spin.heisenberg.MeterDipoleMoment

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<MeterDipoleMoment.ForceTorque>, IDataSource

public class MeterDipoleMoment
extends java.lang.Object
implements IDataSource, AtomLeafAgentManager.AgentSource<MeterDipoleMoment.ForceTorque>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MeterDipoleMoment.ForceTorque

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected DataDoubleArray	data
protected DataDoubleArray.DataInfoDoubleArray	dataInfo
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
MeterDipoleMoment(Box box)

Method Summary

Modifier and Type	Method	Description
IData	getData()
IDataInfo	getDataInfo()
DataTag	getTag()
MeterDipoleMoment.ForceTorque	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
void	releaseAgent(MeterDipoleMoment.ForceTorque agent, IAtom atom, Box agentBox)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected final DataDoubleArray data

dataInfo

protected final DataDoubleArray.DataInfoDoubleArray dataInfo

tag

protected final DataTag tag

box

protected final Box box

Constructor Detail

MeterDipoleMoment

public MeterDipoleMoment(Box box)

Method Detail

getData

public IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

makeAgent

public MeterDipoleMoment.ForceTorque makeAgent(IAtom a,
                                               Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

Returns an agent for the given Atom. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

makeAgent in interface AtomLeafAgentManager.AgentSource<MeterDipoleMoment.ForceTorque>

agentBox - TODO

releaseAgent

public void releaseAgent(MeterDipoleMoment.ForceTorque agent,
                         IAtom atom,
                         Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

releaseAgent in interface AtomLeafAgentManager.AgentSource<MeterDipoleMoment.ForceTorque>