Package etomica.modules.adsorption

Class MeterExcessAdsorbed

java.lang.Object

etomica.data.DataSourceScalar

etomica.modules.adsorption.MeterExcessAdsorbed

All Implemented Interfaces:

IDataSource

public class MeterExcessAdsorbed
extends DataSourceScalar

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected int	dim
protected EOSSW	eos
protected double	pressure
protected ISpecies	species
protected double	xMax
protected double	xMin

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
MeterExcessAdsorbed(ISpecies species, EOSSW eos)

Method Summary

Modifier and Type	Method	Description
double	getDataAsScalar()	Returns a single scalar value as the measurement for the given box.
void	setBox(Box box)
void	setPressure(double pressure)
void	setRange(int dim, double xMin, double xMax)

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

Field Detail

box

protected Box box

dim

protected int dim

xMin

protected double xMin

xMax

protected double xMax

pressure

protected double pressure

eos

protected final EOSSW eos

species

protected final ISpecies species

Constructor Detail

MeterExcessAdsorbed

public MeterExcessAdsorbed(ISpecies species,
                           EOSSW eos)

Method Detail

setRange

public void setRange(int dim,
                     double xMin,
                     double xMax)

setBox

public void setBox(Box box)

setPressure

public void setPressure(double pressure)

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