Package etomica.mappedRdf

Class MeterMappedRdf

java.lang.Object

etomica.mappedRdf.MeterMappedRdf

All Implemented Interfaces:

AtomLeafAgentManager.AgentSource<Vector>, DataSourceIndependent, IDataSource

public class MeterMappedRdf
extends java.lang.Object
implements IDataSource, DataSourceIndependent, AtomLeafAgentManager.AgentSource<Vector>

Calculates pair distribution using mapped averaging

Field Summary

Fields

Modifier and Type	Field	Description
protected IteratorDirective	allAtoms
protected Box	box
protected DataFunction	data
protected double	density
protected AtomLeafAgentManager<Vector>	forceManager
protected PotentialCalculationMappedRdf	pc
protected PotentialCalculationForceSum	pcForce
protected PotentialMaster	potentialMaster
protected double	rcforHandfinmap
protected DataDoubleArray	rData
protected Space	space
protected DataTag	tag
protected DataSourceUniform	xDataSource
protected double	xMax

Constructor Summary

Constructors

Constructor	Description
MeterMappedRdf(double rcforHandfinmap, Space space, PotentialMaster potentialMaster, Box box, int nbins, double density)

Method Summary

Modifier and Type	Method	Description
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()
PotentialCalculationMappedRdf	getPotentialCalculation()
DataTag	getTag()
DataSourceUniform	getXDataSource()
Vector	makeAgent(IAtom a, Box agentBox)	Returns an agent for the given Atom.
void	releaseAgent(Vector agent, IAtom atom, Box agentBox)	This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements.
void	reset()	Zero's out the RDF sum tracked by this meter.
void	setBox(Box box)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

pcForce

protected final PotentialCalculationForceSum pcForce

forceManager

protected final AtomLeafAgentManager<Vector> forceManager

density

protected double density

rcforHandfinmap

protected double rcforHandfinmap

box

protected Box box

space

protected final Space space

data

protected DataFunction data

rData

protected DataDoubleArray rData

allAtoms

protected IteratorDirective allAtoms

xDataSource

protected final DataSourceUniform xDataSource

xMax

protected double xMax

tag

protected final DataTag tag

potentialMaster

protected final PotentialMaster potentialMaster

pc

protected final PotentialCalculationMappedRdf pc

Constructor Detail

MeterMappedRdf

public MeterMappedRdf(double rcforHandfinmap,
                      Space space,
                      PotentialMaster potentialMaster,
                      Box box,
                      int nbins,
                      double density)

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

reset

public void reset()

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

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()

getPotentialCalculation

public PotentialCalculationMappedRdf getPotentialCalculation()

setName

public void setName(java.lang.String name)

makeAgent

public Vector makeAgent(IAtom a,
                        Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

Returns an agent for the given Atom. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

makeAgent in interface AtomLeafAgentManager.AgentSource<Vector>

agentBox - TODO

releaseAgent

public void releaseAgent(Vector agent,
                         IAtom atom,
                         Box agentBox)

Description copied from interface: AtomLeafAgentManager.AgentSource

This informs the agent source that the agent is going away and that the agent source should disconnect the agent from other elements. The agentBox is provided for convenience for agent sources that handle multiple boxes.

Specified by:

releaseAgent in interface AtomLeafAgentManager.AgentSource<Vector>