Package etomica.data.meter

Class MeterLocalDensity

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.meter.MeterLocalDensity

All Implemented Interfaces:

IDataSource

public abstract class MeterLocalDensity
extends DataSourceScalar

Meter for measurement of density within a specified subvolume

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterLocalDensity(Box _box)

Method Summary

Modifier and Type	Method	Description
double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.
AtomIteratorBoxDependent	getIterator()
Polytope	getShape()
void	setIterator(AtomIteratorBoxDependent iterator)
void	setShape(Polytope shape)

Methods inherited from class etomica.data.DataSourceScalar

getData, getDataDouble, getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Constructor Detail

MeterLocalDensity

public MeterLocalDensity(Box _box)

Method Detail

setShape

public void setShape(Polytope shape)

getShape

public Polytope getShape()

getDataAsScalar

public double getDataAsScalar()

Description copied from class: DataSourceScalar

Returns a single scalar value as the measurement for the given box. Subclasses define this method to specify the measurement they make.

Specified by:

getDataAsScalar in class DataSourceScalar

Returns:

the current value of the local density or local mole fraction

getIterator

public AtomIteratorBoxDependent getIterator()

Returns:

Returns the iterator.

setIterator

public void setIterator(AtomIteratorBoxDependent iterator)

Parameters:

iterator - The iterator to set.