Package etomica.data.meter

Class MeterMoleFraction

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.meter.MeterMoleFraction

All Implemented Interfaces:

IDataSource

public class MeterMoleFraction
extends DataSourceScalar

Meter for measurement of the species mole fraction in a box. Mole fraction is defined (number of molecules of species)/(number of molecules in box).

Field Summary

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterMoleFraction()

Method Summary

Modifier and Type	Method	Description
Box	getBox()
double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.
ISpecies	getSpecies()
void	setBox(Box box)
void	setSpecies(ISpecies s)

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

MeterMoleFraction

public MeterMoleFraction()

Method Detail

setSpecies

public void setSpecies(ISpecies s)

getSpecies

public ISpecies getSpecies()

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

getBox

public Box getBox()

Returns:

Returns the box.

setBox

public void setBox(Box box)

Parameters:

box - The box to set.