Package etomica.normalmode

Class BoltzmannProcessor

java.lang.Object

etomica.data.DataProcessor

etomica.normalmode.BoltzmannProcessor

All Implemented Interfaces:

DataPipe, IDataSink

public class BoltzmannProcessor
extends DataProcessor

DataProcessor that returns the Boltzmann factor of the incoming energy.

Field Summary

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
BoltzmannProcessor()

Method Summary

Modifier and Type	Method	Description
double	getTemperature()
IData	processData(IData incomingData)	Processes the input Data and returns Data for pushing to the next DataSink.
IDataInfo	processDataInfo(IDataInfo incomingDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	setEnergyBase(double newEnergyBase)
void	setTemperature(double newTemperature)

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

Constructor Detail

BoltzmannProcessor

public BoltzmannProcessor()

Method Detail

processDataInfo

public IDataInfo processDataInfo(IDataInfo incomingDataInfo)

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:

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

setEnergyBase

public void setEnergyBase(double newEnergyBase)

processData

public IData processData(IData incomingData)

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:

incomingData - the Data for processing

Returns:

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

getTemperature

public double getTemperature()

setTemperature

public void setTemperature(double newTemperature)