Package etomica.normalmode

Class MeterWorkHarmonicUmbrella

java.lang.Object

etomica.normalmode.MeterWorkHarmonicUmbrella

All Implemented Interfaces:

IDataSource

public class MeterWorkHarmonicUmbrella
extends java.lang.Object
implements IDataSource

Meter used for direct sampling in the harmonic-sampled system. The meter measures the energy difference between the Umbrella's sampling region and harmonic system

Field Summary

Fields

Modifier and Type	Field	Description
protected DataDouble	data
protected DataDouble.DataInfoDouble	dataInfo
protected IntegratorBox	integrator
protected double	latticeEnergy
protected MeterHarmonicEnergy	meterHarmonic
protected MeterPotentialEnergy	meterTarget
protected double	refPref
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
MeterWorkHarmonicUmbrella(IntegratorBox integrator, MeterHarmonicEnergy meterHarmonic)

Method Summary

Modifier and Type	Method	Description
IData	getData()
IDataInfo	getDataInfo()
double	getRefPref()
DataTag	getTag()
void	setLatticeEnergy(double newLatticeEnergy)
void	setRefPref(double refPref)

Methods inherited from class java.lang.Object

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

Field Detail

meterTarget

protected final MeterPotentialEnergy meterTarget

meterHarmonic

protected final MeterHarmonicEnergy meterHarmonic

integrator

protected final IntegratorBox integrator

data

protected final DataDouble data

dataInfo

protected final DataDouble.DataInfoDouble dataInfo

tag

protected final DataTag tag

latticeEnergy

protected double latticeEnergy

refPref

protected double refPref

Constructor Detail

MeterWorkHarmonicUmbrella

public MeterWorkHarmonicUmbrella(IntegratorBox integrator,
                                 MeterHarmonicEnergy meterHarmonic)

Method Detail

getData

public IData getData()

Specified by:

getData in interface IDataSource

Returns:

the data given by this source

setLatticeEnergy

public void setLatticeEnergy(double newLatticeEnergy)

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

getRefPref

public double getRefPref()

setRefPref

public void setRefPref(double refPref)