Package etomica.data

Class DataSourceRmsVelocity

java.lang.Object

etomica.data.DataSourceRmsVelocity

All Implemented Interfaces:

DataSourceAtomic, DataSourceIndependent, IDataSource, java.io.Serializable

public class DataSourceRmsVelocity
extends java.lang.Object
implements IDataSource, DataSourceAtomic, DataSourceIndependent, java.io.Serializable

Meter for the root-mean-square velocity of a set of atoms. Useful to obtain histograms of atom speeds.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataTag	tag
protected DataDoubleArray	xData
protected DataDoubleArray.DataInfoDoubleArray	xDataInfo
protected DataTag	xTag

Constructor Summary

Constructors

Constructor	Description
DataSourceRmsVelocity()
DataSourceRmsVelocity(Histogram histogram)

Method Summary

Modifier and Type	Method	Description
IDataInfo	getAtomDataInfo()
IData	getData()	Returns the rms velocity of the atoms given by the iterator.
IData	getData(IAtom a)
IDataInfo	getDataInfo()
int	getIndependentArrayDimension()	Returns the number of independent data dimensions
DataDoubleArray	getIndependentData(int i)	Returns the X data for the given dimension
DataDoubleArray.DataInfoDoubleArray	getIndependentDataInfo(int i)	Returns the DataInfo for the given dimension
DataTag	getIndependentTag()	Returns the tag associated with this DataSource.
AtomIterator	getIterator()
DataTag	getTag()
void	setIterator(AtomIterator newIterator)	Sets the iterator defining the atoms for which the RMS velocity is calculated.
protected void	setupData()	Creates the data object (a DataFunction) to be returned by getData().

Methods inherited from class java.lang.Object

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

Field Detail

xData

protected DataDoubleArray xData

xDataInfo

protected DataDoubleArray.DataInfoDoubleArray xDataInfo

tag

protected final DataTag tag

xTag

protected final DataTag xTag

Constructor Detail

DataSourceRmsVelocity

public DataSourceRmsVelocity()

DataSourceRmsVelocity

public DataSourceRmsVelocity(Histogram histogram)

Method Detail

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

getTag

public DataTag getTag()

Specified by:

getTag in interface DataSourceAtomic

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

getAtomDataInfo

public IDataInfo getAtomDataInfo()

Specified by:

getAtomDataInfo in interface DataSourceAtomic

getData

public IData getData()

Returns the rms velocity of the atoms given by the iterator. Value is given in the first element of the array, which is always of dimension 1.

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

setupData

protected void setupData()

Creates the data object (a DataFunction) to be returned by getData(). data wraps the histogram's double[] so copying is not needed.

getData

public IData getData(IAtom a)

Specified by:

getData in interface DataSourceAtomic

getIndependentData

public DataDoubleArray getIndependentData(int i)

Description copied from interface: DataSourceIndependent

Returns the X data for the given dimension

Specified by:

getIndependentData in interface DataSourceIndependent

getIndependentDataInfo

public DataDoubleArray.DataInfoDoubleArray getIndependentDataInfo(int i)

Description copied from interface: DataSourceIndependent

Returns the DataInfo for the given dimension

Specified by:

getIndependentDataInfo in interface DataSourceIndependent

getIndependentArrayDimension

public int getIndependentArrayDimension()

Description copied from interface: DataSourceIndependent

Returns the number of independent data dimensions

Specified by:

getIndependentArrayDimension in interface DataSourceIndependent

getIndependentTag

public DataTag getIndependentTag()

Description copied from interface: DataSourceIndependent

Returns the tag associated with this DataSource.

Specified by:

getIndependentTag in interface DataSourceIndependent

setIterator

public void setIterator(AtomIterator newIterator)

Sets the iterator defining the atoms for which the RMS velocity is calculated.

Parameters:

newIterator -

getIterator

public AtomIterator getIterator()

Returns:

The iterator defining the atoms used for the RMS velocity calculation