Package etomica.data.meter

Class MeterRDF

java.lang.Object

etomica.data.meter.MeterRDF

All Implemented Interfaces:

IAction, DataSourceIndependent, IDataSource

Direct Known Subclasses:

MeterCavity, MeterRDFCylinder

public class MeterRDF
extends java.lang.Object
implements IAction, IDataSource, DataSourceIndependent

Meter for tabulation of the atomic radial distribution function (RDF). The meter takes data via actionPerformed and returns the average RDF via getData.

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected long	callCount
protected DataFunction	data
protected Vector	dr
protected long[]	gSum
protected AtomsetIteratorBoxDependent	iterator
protected DataDoubleArray	rData
protected boolean	resetAfterData
protected boolean	singleSample
protected Space	space
protected DataTag	tag
protected AtomType	type1
protected AtomType	type2
protected DataSourceUniform	xDataSource
protected double	xMax

Constructor Summary

Constructors

Constructor	Description
MeterRDF(Space space)	Creates meter with default to compute pair correlation for all leaf atoms in a box.
MeterRDF(Space space, boolean singleSample)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Takes the RDF for the current configuration of the given box.
Box	getBox()
IData	getData()	Returns the RDF, averaged over the calls to actionPerformed since the meter was reset or had some parameter changed (xMax or # of bins).
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.
java.lang.String	getName()
DataTag	getTag()
DataSourceUniform	getXDataSource()
void	reset()	Zero's out the RDF sum tracked by this meter.
void	setAtomType(AtomType type)
void	setAtomTypes(AtomType type1, AtomType type2)
void	setBox(Box box)
void	setName(java.lang.String name)
void	zeroData()

Methods inherited from class java.lang.Object

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

Field Detail

space

protected final Space space

xDataSource

protected final DataSourceUniform xDataSource

tag

protected final DataTag tag

dr

protected final Vector dr

box

protected Box box

gSum

protected long[] gSum

data

protected DataFunction data

rData

protected DataDoubleArray rData

iterator

protected AtomsetIteratorBoxDependent iterator

xMax

protected double xMax

callCount

protected long callCount

type1

protected AtomType type1

type2

protected AtomType type2

resetAfterData

protected boolean resetAfterData

singleSample

protected final boolean singleSample

Constructor Detail

MeterRDF

public MeterRDF(Space space)

Creates meter with default to compute pair correlation for all leaf atoms in a box.

Parameters:

space -

MeterRDF

public MeterRDF(Space space,
                boolean singleSample)

Method Detail

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

setAtomType

public void setAtomType(AtomType type)

setAtomTypes

public void setAtomTypes(AtomType type1,
                         AtomType type2)

reset

public void reset()

Zero's out the RDF sum tracked by this meter.

zeroData

public void zeroData()

actionPerformed

public void actionPerformed()

Takes the RDF for the current configuration of the given box.

Specified by:

actionPerformed in interface IAction

getData

public IData getData()

Returns the RDF, averaged over the calls to actionPerformed since the meter was reset or had some parameter changed (xMax or # of bins).

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

getXDataSource

public DataSourceUniform getXDataSource()

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

getIndependentTag

public DataTag getIndependentTag()

Description copied from interface: DataSourceIndependent

Returns the tag associated with this DataSource.

Specified by:

getIndependentTag 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

getBox

public Box getBox()

Returns:

Returns the box.

setBox

public void setBox(Box box)

Parameters:

box - The box to set.

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)