Package etomica.cavity

Class MeterWidomCavity

java.lang.Object

etomica.cavity.MeterWidomCavity

All Implemented Interfaces:

DataSourceIndependent, IDataSource

public class MeterWidomCavity
extends java.lang.Object
implements IDataSource, DataSourceIndependent

Field Summary

Fields

Modifier and Type	Field	Description
protected Box	box
protected DataFunction	data
protected DataFunction.DataInfoFunction	dataInfo
protected Vector	dr
protected Vector	r0
protected IRandom	random
protected DataDoubleArray	rData
protected DataDoubleArray.DataInfoDoubleArray	rDataInfo
protected DataTag	rTag
protected DataTag	tag
protected IMolecule	testMolecule

Constructor Summary

Constructors

Constructor	Description
MeterWidomCavity(Box box, IRandom random, PotentialMaster potentialMaster)

Method Summary

Modifier and Type	Method	Description
IData	getData()
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.
int	getNInsert()	Accessor to number of Widom insertions attempted with each call to currentValue
ISpecies	getSpecies()	Accessor for the species for which chemical potential is evaluated
DataTag	getTag()
void	setInsertionDistances(double[] r)
void	setNInsert(int n)	Number of Widom insertions attempted with each call to currentValue
void	setSpecies(ISpecies s)	Sets the species, takes a prototype molecule, and gets handle to appropriate species agent in box

Methods inherited from class java.lang.Object

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

Field Detail

data

protected DataFunction data

dataInfo

protected DataFunction.DataInfoFunction dataInfo

tag

protected final DataTag tag

rTag

protected final DataTag rTag

rData

protected DataDoubleArray rData

rDataInfo

protected DataDoubleArray.DataInfoDoubleArray rDataInfo

random

protected final IRandom random

box

protected Box box

dr

protected final Vector dr

r0

protected final Vector r0

testMolecule

protected IMolecule testMolecule

Constructor Detail

MeterWidomCavity

public MeterWidomCavity(Box box,
                        IRandom random,
                        PotentialMaster potentialMaster)

Method Detail

setInsertionDistances

public void setInsertionDistances(double[] r)

setSpecies

public void setSpecies(ISpecies s)

Sets the species, takes a prototype molecule, and gets handle to appropriate species agent in box

getSpecies

public ISpecies getSpecies()

Accessor for the species for which chemical potential is evaluated

setNInsert

public void setNInsert(int n)

Number of Widom insertions attempted with each call to currentValue

getNInsert

public int getNInsert()

Accessor to number of Widom insertions attempted with each call to currentValue

getData

public IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

getTag

public DataTag getTag()

Specified by:

getTag in interface IDataSource

Returns:

a tag that uniquely identifies the IDataInfo

getDataInfo

public IDataInfo getDataInfo()

Specified by:

getDataInfo in interface IDataSource

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