Package etomica.spin.heisenberg

Class MeterMappedAveragingPairExcess

java.lang.Object

etomica.spin.heisenberg.MeterMappedAveragingPairExcess

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<MoleculeAgent>, IDataSource

public class MeterMappedAveragingPairExcess
extends java.lang.Object
implements IDataSource, AtomLeafAgentManager.AgentSource<MoleculeAgent>

Computes pair-mapped average for a single spin pair

Field Summary

Fields

Modifier and Type	Field	Description
protected IteratorDirective	allAtoms
protected PotentialCalculationHeisenberg	ans
protected double	bt
protected DataDoubleArray	data
protected DataDoubleArray.DataInfoDoubleArray	dataInfo
protected Vector	dr
protected double	J
protected AtomLeafAgentManager<MoleculeAgent>	leafAgentManager
protected double	mu
protected int	nMax
protected PotentialMaster	potentialMaster
protected PotentialCalculationPhiSum	secondDerivativeSum
protected PotentialCalculationPhiSumHeisenberg	secondDerivativeSumIdeal
protected Space	space
protected DataTag	tag
protected double	temperature
protected PotentialCalculationTorqueSum	torqueSum
protected Vector	work

Constructor Summary

Constructors

Constructor	Description
MeterMappedAveragingPairExcess(AtomPair pair, Space space, Box box, Simulation sim, double temperature, double interactionS, double dipoleMagnitude, PotentialMaster potentialMaster, P2Spin p2Spin, int nMax)

Method Summary

Modifier and Type	Method	Description
IData	getData()
IDataInfo	getDataInfo()
DataTag	getTag()
MoleculeAgent	makeAgent(IAtom a, Box box)	Returns an agent for the given Atom.
void	releaseAgent(MoleculeAgent agent, IAtom a, Box box)	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

space

protected final Space space

potentialMaster

protected final PotentialMaster potentialMaster

allAtoms

protected final IteratorDirective allAtoms

torqueSum

protected PotentialCalculationTorqueSum torqueSum

secondDerivativeSum

protected PotentialCalculationPhiSum secondDerivativeSum

secondDerivativeSumIdeal

protected PotentialCalculationPhiSumHeisenberg secondDerivativeSumIdeal

temperature

protected double temperature

J

protected double J

mu

protected double mu

bt

protected double bt

nMax

protected int nMax

dr

protected Vector dr

work

protected Vector work

leafAgentManager

protected AtomLeafAgentManager<MoleculeAgent> leafAgentManager

ans

protected final PotentialCalculationHeisenberg ans

Constructor Detail

MeterMappedAveragingPairExcess

public MeterMappedAveragingPairExcess(AtomPair pair,
                                      Space space,
                                      Box box,
                                      Simulation sim,
                                      double temperature,
                                      double interactionS,
                                      double dipoleMagnitude,
                                      PotentialMaster potentialMaster,
                                      P2Spin p2Spin,
                                      int nMax)

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 MoleculeAgent makeAgent(IAtom a,
                               Box box)

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<MoleculeAgent>

box - TODO

releaseAgent

public void releaseAgent(MoleculeAgent agent,
                         IAtom a,
                         Box box)

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<MoleculeAgent>