Package etomica.normalmode

Class MeterBoltzmann

java.lang.Object

etomica.normalmode.MeterBoltzmann

All Implemented Interfaces:

IDataSource

public class MeterBoltzmann
extends java.lang.Object
implements IDataSource

Meter used for overlap sampling in the target-sampled system. The meter measures the ratio of the Boltzmann factors for the reference and target potentials.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataDoubleArray	data
protected DataDoubleArray.DataInfoDoubleArray	dataInfo
protected IntegratorBox	integrator
protected MeterPotentialEnergyFromIntegrator	meterEnergy
protected MeterPotentialEnergy	meterPotentialEnergy
protected DataTag	tag
protected double	ulatMeasured
protected double	ulatSampled

Constructor Summary

Constructors

Constructor	Description
MeterBoltzmann(IntegratorBox integrator, MeterPotentialEnergy meterPotentialEnergy, double ulatSampled, double ulatMeasured)

Method Summary

Modifier and Type	Method	Description
IData	getData()
IDataInfo	getDataInfo()
DataTag	getTag()

Methods inherited from class java.lang.Object

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

Field Detail

meterEnergy

protected final MeterPotentialEnergyFromIntegrator meterEnergy

meterPotentialEnergy

protected final MeterPotentialEnergy meterPotentialEnergy

integrator

protected final IntegratorBox integrator

data

protected final DataDoubleArray data

dataInfo

protected final DataDoubleArray.DataInfoDoubleArray dataInfo

ulatSampled

protected final double ulatSampled

ulatMeasured

protected final double ulatMeasured

tag

protected final DataTag tag

Constructor Detail

MeterBoltzmann

public MeterBoltzmann(IntegratorBox integrator,
                      MeterPotentialEnergy meterPotentialEnergy,
                      double ulatSampled,
                      double ulatMeasured)

Method Detail

getData

public IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

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