Package etomica.virial.overlap

Class DataProcessorVirialOverlap

java.lang.Object

etomica.data.DataProcessor

etomica.virial.overlap.DataProcessorVirialOverlap

All Implemented Interfaces:

DataPipe, IDataSink, AlphaSource

public class DataProcessorVirialOverlap
extends DataProcessor
implements AlphaSource

DataProcessor which takes in values for v/pi and pi2/pi (from MeterVirial) and calculates the overlap values for various values of alpha. This class can also act as an "AlphaSource"

Field Summary

Fields

Modifier and Type	Field	Description
protected double	alphaCenter
protected double	alphaSpan
protected DataDoubleArray	data
protected int	numIncomingValues

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataProcessorVirialOverlap(int aNumAlpha, boolean aIsReference)

Method Summary

Modifier and Type	Method	Description
double	getAlpha(int i)	Returns ith factor used in the overlap value.
double	getAlphaCenter()
double	getAlphaSpan()
int	getNumAlpha()	Returns the number of possible alpha values.
protected IData	processData(IData inputData)	take in v1/pi1, pi0/pi1, spit out v1/pi, overlap0, overlap1, overlap2...
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	setBennetParam(double aCenter, double aSpan)	sets the range of parameter values used for Bennets method.
void	setNumAlpha(int newNumAlpha)
protected void	setup()

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 DataDoubleArray data

alphaCenter

protected double alphaCenter

alphaSpan

protected double alphaSpan

numIncomingValues

protected int numIncomingValues

Constructor Detail

DataProcessorVirialOverlap

public DataProcessorVirialOverlap(int aNumAlpha,
                                  boolean aIsReference)

Method Detail

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

setup

protected void setup()

setBennetParam

public void setBennetParam(double aCenter,
                           double aSpan)

sets the range of parameter values used for Bennets method. Default is a span of 5 centered about 1 (exp(-5) to (exp(5)).

Parameters:

aCenter - geometric mean of all values

aSpan - natural log of ratio of max value to aCenter

setNumAlpha

public void setNumAlpha(int newNumAlpha)

getNumAlpha

public int getNumAlpha()

Description copied from interface: AlphaSource

Returns the number of possible alpha values.

Specified by:

getNumAlpha in interface AlphaSource

getAlphaCenter

public double getAlphaCenter()

getAlphaSpan

public double getAlphaSpan()

processData

protected IData processData(IData inputData)

take in v1/pi1, pi0/pi1, spit out v1/pi, overlap0, overlap1, overlap2... overlapN

Specified by:

processData in class DataProcessor

Parameters:

inputData - the Data for processing

Returns:

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

getAlpha

public double getAlpha(int i)

Returns ith factor used in the overlap value.

Specified by:

getAlpha in interface AlphaSource