MeterCavityMapped

java.lang.Object
- etomica.cavity.MeterCavityMapped

All Implemented Interfaces:

DataSourceIndependent, IDataSource, IntegratorHard.CollisionListener
```
public class MeterCavityMapped
extends java.lang.Object
implements IDataSource, IntegratorHard.CollisionListener, DataSourceIndependent
```
Meter for the cavity function using mapped averaging.

Field Summary

Fields
Modifier and Type	Field	Description
`protected DataFunction`	`data`
`protected DataFunction.DataInfoFunction`	`dataInfo`
`protected Vector`	`deltaMomentum`
`protected Vector`	`dr`
`protected double[]`	`gSum`
`protected IntegratorHard`	`integratorHard`
`protected boolean`	`internal`
`protected long`	`internalCollisions`
`protected double`	`lastSwitchTime`
`protected double`	`lastTime`
`protected double`	`mappingCut2`
`protected DataDoubleArray`	`rawData`
`protected DataFunction.DataInfoFunction`	`rawDataInfo`
`protected IDataSink`	`rawSink`
`protected DataTag`	`rawTag`
`protected DataDoubleArray`	`rData`
`protected boolean`	`resetAfterData`
`protected double`	`sigma`
`protected DataTag`	`tag`
`protected double`	`tExternal`
`protected double`	`tInternal`
`protected long`	`totalCollisions`
`protected boolean`	`useMomentum`
`protected DataSourceUniform`	`xDataSource`

Constructor Summary

Constructors
Constructor Description

MeterCavityMapped(IntegratorHard integrator)

Constructors
Constructor	Description
`MeterCavityMapped(IntegratorHard integrator)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`collisionAction(IntegratorHard.Agent agent)`
`IData`	`getData()`
`IDataInfo`	`getDataInfo()`
`int`	`getIndependentArrayDimension()`	Returns the number of independent data dimensions
`DataDoubleArray`	`getIndependentData(int i)`	Returns the X data for the given dimension
`DataDoubleArray.DataInfoDoubleArray`	`getIndependentDataInfo(int i)`	Returns the DataInfo for the given dimension
`DataTag`	`getIndependentTag()`	Returns the tag associated with this DataSource.
`DataTag`	`getTag()`
`DataSourceUniform`	`getXDataSource()`
`void`	`reset()`	Resets the data collected.
`void`	`setMappingCut(double mappingCut)`
`void`	`setRawSink(IDataSink rawSink)`
`void`	`setResetAfterData(boolean doResetAfterData)`
`void`	`zeroData()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xDataSource

protected final DataSourceUniform xDataSource

rData
```
protected DataDoubleArray rData
```

dataInfo

protected DataFunction.DataInfoFunction dataInfo

data
```
protected DataFunction data
```

tag
```
protected DataTag tag
```

deltaMomentum
```
protected final Vector deltaMomentum
```

integratorHard

protected final IntegratorHard integratorHard

lastTime
```
protected double lastTime
```

dr
```
protected final Vector dr
```

gSum
```
protected double[] gSum
```

lastSwitchTime
```
protected double lastSwitchTime
```

internal
```
protected boolean internal
```

tInternal
```
protected double tInternal
```

tExternal
```
protected double tExternal
```

sigma
```
protected double sigma
```

mappingCut2
```
protected double mappingCut2
```

resetAfterData
```
protected boolean resetAfterData
```

internalCollisions
```
protected long internalCollisions
```

totalCollisions
```
protected long totalCollisions
```

rawSink
```
protected IDataSink rawSink
```

rawTag
```
protected final DataTag rawTag
```

rawDataInfo

protected DataFunction.DataInfoFunction rawDataInfo

rawData
```
protected DataDoubleArray rawData
```

useMomentum
```
protected boolean useMomentum
```

Constructor Detail

MeterCavityMapped

public MeterCavityMapped(IntegratorHard integrator)

Method Detail
- setRawSink
```
public void setRawSink(IDataSink rawSink)
```
- reset
```
public void reset()
```
  Resets the data collected.
- zeroData
```
public void zeroData()
```
- setMappingCut
```
public void setMappingCut(double mappingCut)
```
- setResetAfterData
```
public void setResetAfterData(boolean doResetAfterData)
```
- collisionAction
```
public void collisionAction(IntegratorHard.Agent agent)
```
  Specified by:
  
  collisionAction in interface IntegratorHard.CollisionListener
- 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
- getXDataSource
```
public DataSourceUniform getXDataSource()
```
- getIndependentData
```
public DataDoubleArray getIndependentData(int i)
```
  Description copied from interface: DataSourceIndependent
  
  Returns the X data for the given dimension
  
  Specified by:
  
  getIndependentData in interface DataSourceIndependent
- getIndependentDataInfo
```
public DataDoubleArray.DataInfoDoubleArray getIndependentDataInfo(int i)
```
  Description copied from interface: DataSourceIndependent
  
  Returns the DataInfo for the given dimension
  
  Specified by:
  
  getIndependentDataInfo in interface DataSourceIndependent
- getIndependentTag
```
public DataTag getIndependentTag()
```
  Description copied from interface: DataSourceIndependent
  
  Returns the tag associated with this DataSource.
  
  Specified by:
  
  getIndependentTag in interface DataSourceIndependent
- getIndependentArrayDimension
```
public int getIndependentArrayDimension()
```
  Description copied from interface: DataSourceIndependent
  
  Returns the number of independent data dimensions
  
  Specified by:
  
  getIndependentArrayDimension in interface DataSourceIndependent

Class MeterCavityMapped

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xDataSource

rData

dataInfo

data

tag

deltaMomentum

integratorHard

lastTime

dr

gSum

lastSwitchTime

internal

tInternal

tExternal

sigma

mappingCut2

resetAfterData

internalCollisions

totalCollisions

rawSink

rawTag

rawDataInfo

rawData

useMomentum

Constructor Detail

MeterCavityMapped

Method Detail

setRawSink

reset

zeroData

setMappingCut

setResetAfterData

collisionAction

getData

getTag

getDataInfo

getXDataSource

getIndependentData

getIndependentDataInfo

getIndependentTag

getIndependentArrayDimension