Package etomica.cavity

Class DataProcessorCavity

java.lang.Object

etomica.data.DataProcessor

etomica.cavity.DataProcessorCavity

All Implemented Interfaces:

DataPipe, IDataSink, IntegratorHard.CollisionListener

public class DataProcessorCavity
extends DataProcessor
implements IntegratorHard.CollisionListener

This processor scales up the measured cavity function so that its contact value is equal to the RDF contact value.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataFunction	data
protected long	internalCollisions
protected double	sigma
protected long	totalCollisions

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataProcessorCavity(IntegratorHard integrator)

Method Summary

Modifier and Type	Method	Description
void	collisionAction(IntegratorHard.Agent agent)
protected IData	processData(IData inputData)	Processes the input Data and returns Data for pushing to the next DataSink.
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	reset()

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Field Detail

data

protected DataFunction data

internalCollisions

protected long internalCollisions

totalCollisions

protected long totalCollisions

sigma

protected double sigma

Constructor Detail

DataProcessorCavity

public DataProcessorCavity(IntegratorHard integrator)

Method Detail

reset

public void reset()

collisionAction

public void collisionAction(IntegratorHard.Agent agent)

Specified by:

collisionAction in interface IntegratorHard.CollisionListener

processData

protected IData processData(IData inputData)

Description copied from class: DataProcessor

Processes the input Data and returns Data for pushing to the next DataSink. Returns null if output Data should not (yet) be pushed downstream.

Specified by:

processData in class DataProcessor

Parameters:

inputData - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Description copied from class: DataProcessor

Informs this DataProcessor of the DataInfo for the Data it will be processing. Typically the subclass will use this information to make any objects or otherwise prepare for calls to processData.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

the DataInfo of the Data that will be output by this DataProcessor