Package etomica.data

Class DataProcessorChemicalPotential

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorChemicalPotential

All Implemented Interfaces:

DataPipe, IDataSink

public class DataProcessorChemicalPotential
extends DataProcessor

DataProcessor that takes as input the average density and average Boltzmann factor profiles and calculates the chemical potential profile as the sum of the ideal gas contribution (kT ln()) and the excess chemical potential, (-kT ln()). The incoming data is expected to be the Boltzmann factor, while the density is taken from a DataSource.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataFunction	data
protected IDataSource	densityProfileSource
protected IntegratorBox	integrator

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataProcessorChemicalPotential()

Method Summary

Modifier and Type	Method	Description
IDataSource	getDenstiyProfileDump()
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	setDensityProfileDump(IDataSource newDensityProfileSource)
void	setIntegrator(IntegratorBox newIntegrator)

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

densityProfileSource

protected IDataSource densityProfileSource

data

protected DataFunction data

integrator

protected IntegratorBox integrator

Constructor Detail

DataProcessorChemicalPotential

public DataProcessorChemicalPotential()

Method Detail

setDensityProfileDump

public void setDensityProfileDump(IDataSource newDensityProfileSource)

getDenstiyProfileDump

public IDataSource getDenstiyProfileDump()

setIntegrator

public void setIntegrator(IntegratorBox newIntegrator)

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