Package etomica.data.meter

Class MeterProfile

java.lang.Object

etomica.data.meter.MeterProfile

All Implemented Interfaces:

DataSourceIndependent, IDataSource, java.io.Serializable

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

Meter that takes a (scalar) Meter and records its property as a 1-dimensional function of position in the simulation volume. The measured property must be a quantity that can be associated with a position in the box. The position coordinate lies along one dimension (x,y,z).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSourcePositioned	meter	Meter that defines the property being profiled.
protected RandomPositionSource	positionSource
protected int	profileDim	Vector describing the orientation of the profile.
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
MeterProfile(Space space, IRandom random)	Default constructor sets profile along the x-axis, with 100 points in the profile.

Method Summary

Modifier and Type	Method	Description
Box	getBox()
IData	getData()	Returns the profile for the current configuration.
IDataInfo	getDataInfo()
DataSourcePositioned	getDataSource()	The meter that defines the profiled quantity
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.
RandomPositionSource	getPositionSource()	Returns the RandomPositionSource used by this meter.
int	getProfileDim()	Accessor method for vector describing the direction along which the profile is measured.
DataTag	getTag()
void	reset()
void	setBox(Box box)
void	setDataSource(DataSourcePositioned m)	Accessor method for the meter that defines the profiled quantity.
void	setPositionSource(RandomPositionSource newPositionSource)	Sets a new RandomPositionSource for this meter to use.
void	setProfileDim(int dim)	Accessor method for vector describing the direction along which the profile is measured.

Methods inherited from class java.lang.Object

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

Field Detail

positionSource

protected RandomPositionSource positionSource

profileDim

protected int profileDim

Vector describing the orientation of the profile. For example, (1,0) is along the x-axis.

meter

protected DataSourcePositioned meter

Meter that defines the property being profiled.

tag

protected final DataTag tag

Constructor Detail

MeterProfile

public MeterProfile(Space space,
                    IRandom random)

Default constructor sets profile along the x-axis, with 100 points in the profile.

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

getDataSource

public DataSourcePositioned getDataSource()

The meter that defines the profiled quantity

setDataSource

public void setDataSource(DataSourcePositioned m)

Accessor method for the meter that defines the profiled quantity.

getProfileDim

public int getProfileDim()

Accessor method for vector describing the direction along which the profile is measured. Each atom position is dotted along this vector to obtain its profile abscissa value.

setProfileDim

public void setProfileDim(int dim)

Accessor method for vector describing the direction along which the profile is measured. Each atom position is dotted along this vector to obtain its profile abscissa value. The given vector is converted to a unit vector, if not already.

getData

public IData getData()

Returns the profile for the current configuration.

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

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

getBox

public Box getBox()

Returns:

Returns the box.

setBox

public void setBox(Box box)

Parameters:

box - The box to set.

reset

public void reset()

setPositionSource

public void setPositionSource(RandomPositionSource newPositionSource)

Sets a new RandomPositionSource for this meter to use. By default, a position source is used which assumes rectangular boundaries.

getPositionSource

public RandomPositionSource getPositionSource()

Returns the RandomPositionSource used by this meter.