etomica.data

Class DataProcessorInterfacialTension

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorInterfacialTension

All Implemented Interfaces:

DataPipe, IDataSink

public class DataProcessorInterfacialTension
extends DataProcessor

Data Processor that takes the virial components as input data and returns the interfacial tension. This class must be told which dimension the surfaces exist in.

Field Summary

Fields

Modifier and Type	Field and Description
protected IBox	box
protected DataDouble	data
protected ISpace	space
protected int	surfaceDim

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag, trueDataSink

Constructor Summary

Constructors

Constructor and Description
DataProcessorInterfacialTension(ISpace space)

Method Summary

Modifier and Type	Method and Description
IBox	getBox()
DataPipe	getDataCaster(IEtomicaDataInfo inputDataInfo) Returns a DataProcessor that casts the data that will be given to this DataSink to a form that it can accept.
int	getSurfaceDimension() Returns the dimension of the surfaces.
protected IData	processData(IData inputData) Processes the input Data and returns Data for pushing to the next DataSink.
protected IEtomicaDataInfo	processDataInfo(IEtomicaDataInfo inputDataInfo) Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	setBox(IBox newBox)
void	setSurfaceDimension(int newDim) Sets the dimension of the surfaces.

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, insertTransformerIfNeeded, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Field Detail

space

protected final ISpace space

box

protected IBox box

data

protected final DataDouble data

surfaceDim

protected int surfaceDim

Constructor Detail

DataProcessorInterfacialTension

public DataProcessorInterfacialTension(ISpace space)

Method Detail

setBox

public void setBox(IBox newBox)

getBox

public IBox getBox()

setSurfaceDimension

public void setSurfaceDimension(int newDim)

Sets the dimension of the surfaces. 0 (x) means that the surfaces exist in the yz plane.

getSurfaceDimension

public int getSurfaceDimension()

Returns the dimension of the surfaces. 0 (x) means that the surfaces exist in the yz plane.

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 IEtomicaDataInfo processDataInfo(IEtomicaDataInfo 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

Returns:

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

getDataCaster

public DataPipe getDataCaster(IEtomicaDataInfo inputDataInfo)

Description copied from interface: IDataSink

Returns a DataProcessor that casts the data that will be given to this DataSink to a form that it can accept. Returns null if the Data is acceptable without casting. Otherwise object that is pushing the Data into this DataSink is responsible for filtering the Data through the returned DataTransformer.

Parameters:

inputDataInfo - the DataInfo for the Data that will fed to the sink's putData method