MeterMappedAveragingVSum

java.lang.Object
- etomica.spin.heisenberg.MeterMappedAveragingVSum

All Implemented Interfaces:: AtomLeafAgentManager.AgentSource<MoleculeAgent>, IDataSource

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected IteratorDirective`	`allAtoms`
`protected PotentialCalculationHeisenberg`	`Ans`
`protected double`	`bJ`
`protected double`	`bt`
`protected DataDoubleArray`	`data`
`protected DataDoubleArray.DataInfoDoubleArray`	`dataInfo`
`protected boolean`	`doAEEMF`
`protected boolean`	`doIdeal`
`protected boolean`	`doPair`
`protected boolean`	`doVSum`
`protected boolean`	`doVSumMI`
`protected Vector`	`dr`
`protected Vector[]`	`dtdotkdetak`
`protected Vector[]`	`dtdotkdt0k`
`protected PotentialCalculationEnergySum`	`energySum`
`protected AtomLeafAgentManager<MoleculeAgent>`	`leafAgentManager`
`protected MeterMeanField`	`meterMeanField`
`protected double`	`mu`
`protected int`	`N`
`protected double[]`	`nbrCsum`
`protected double[]`	`nbrSsum`
`protected int`	`nMax`
`protected MeterEnergyMeanField.PotentialCalculationCSsum`	`pcCSsum`
`protected etomica.spin.heisenberg.MeterMappedAveragingVSum.PotentialCalculationPhiijMF`	`pcPhiIJ`
`protected double`	`phiIJsum`
`protected PotentialMaster`	`potentialMaster`
`protected PotentialCalculationPhiSum`	`secondDerivativeSum`
`protected PotentialCalculationPhiSumHeisenberg`	`secondDerivativeSumIdeal`
`protected Space`	`space`
`protected DataTag`	`tag`
`protected double`	`temperature`
`protected Vector`	`tmp`
`protected PotentialCalculationTorqueSum`	`torqueSum`
`protected PotentialCalculationMoleculeAgentSum`	`vSum`
`protected PotentialCalculationMoleculeAgentSumMinusIdeal`	`vSumMinusIdeal`
`protected PotentialCalculationMoleculeAgentSumPair`	`vSumPair`
`protected PotentialCalculationMoleculeAgentSumMinusIdealPair`	`vSumPairMinusIdeal`
`protected Vector`	`workVector`

Constructor Summary

Constructors
Constructor	Description
`MeterMappedAveragingVSum(Space space, Box box, Simulation sim, double temperature, double interactionS, double dipoleMagnitude, PotentialMaster potentialMaster, boolean doIdeal, boolean doPair, boolean doVSum, boolean doVSumMI, boolean doAEEMF, int nMax)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`getAns(IAtom atom)`
`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

energySum

protected PotentialCalculationEnergySum energySum

torqueSum

protected PotentialCalculationTorqueSum torqueSum

secondDerivativeSum

protected PotentialCalculationPhiSum secondDerivativeSum

secondDerivativeSumIdeal

protected PotentialCalculationPhiSumHeisenberg secondDerivativeSumIdeal

vSum

protected PotentialCalculationMoleculeAgentSum vSum

vSumMinusIdeal

protected PotentialCalculationMoleculeAgentSumMinusIdeal vSumMinusIdeal

vSumPair

protected PotentialCalculationMoleculeAgentSumPair vSumPair

vSumPairMinusIdeal

protected PotentialCalculationMoleculeAgentSumMinusIdealPair vSumPairMinusIdeal

temperature
```
protected final double temperature
```

bJ
```
protected final double bJ
```

mu
```
protected final double mu
```

bt
```
protected final double bt
```

doIdeal
```
protected boolean doIdeal
```

doPair
```
protected boolean doPair
```

doVSum
```
protected boolean doVSum
```

doVSumMI
```
protected boolean doVSumMI
```

doAEEMF
```
protected boolean doAEEMF
```

nMax
```
protected int nMax
```

dr
```
protected Vector dr
```

tmp
```
protected Vector tmp
```

workVector
```
protected Vector workVector
```

leafAgentManager

protected AtomLeafAgentManager<MoleculeAgent> leafAgentManager

N
```
protected final int N
```

meterMeanField

protected final MeterMeanField meterMeanField

nbrSsum
```
protected double[] nbrSsum
```

nbrCsum
```
protected double[] nbrCsum
```

dtdotkdt0k
```
protected final Vector[] dtdotkdt0k
```

dtdotkdetak
```
protected final Vector[] dtdotkdetak
```

pcCSsum

protected MeterEnergyMeanField.PotentialCalculationCSsum pcCSsum

Ans

protected PotentialCalculationHeisenberg Ans

pcPhiIJ

protected etomica.spin.heisenberg.MeterMappedAveragingVSum.PotentialCalculationPhiijMF pcPhiIJ

phiIJsum
```
protected double phiIJsum
```

Constructor Detail

MeterMappedAveragingVSum

public MeterMappedAveragingVSum(Space space,
                                Box box,
                                Simulation sim,
                                double temperature,
                                double interactionS,
                                double dipoleMagnitude,
                                PotentialMaster potentialMaster,
                                boolean doIdeal,
                                boolean doPair,
                                boolean doVSum,
                                boolean doVSumMI,
                                boolean doAEEMF,
                                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>
- getAns
```
public void getAns(IAtom atom)
```

Class MeterMappedAveragingVSum

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

dataInfo

tag

space

potentialMaster

allAtoms

energySum

torqueSum

secondDerivativeSum

secondDerivativeSumIdeal

vSum

vSumMinusIdeal

vSumPair

vSumPairMinusIdeal

temperature

bJ

mu

bt

doIdeal

doPair

doVSum

doVSumMI

doAEEMF

nMax

dr

tmp

workVector

leafAgentManager

N

meterMeanField

nbrSsum

nbrCsum

dtdotkdt0k

dtdotkdetak

pcCSsum

Ans

pcPhiIJ

phiIJsum

Constructor Detail

MeterMappedAveragingVSum

Method Detail

getData

getTag

getDataInfo

makeAgent

releaseAgent

getAns