Package etomica.data

Class DataSourceAcceptanceRatio

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.DataSourceAcceptanceRatio

All Implemented Interfaces:

IDataSource

Direct Known Subclasses:

DataSourceAcceptanceProbability

public class DataSourceAcceptanceRatio
extends DataSourceScalar

Data source giving the acceptance rate of MCMove type moves. Returns acceptance rate as kept by the MCMove.

Field Summary

Fields

Modifier and Type	Field	Description
protected MCMove	move

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
DataSourceAcceptanceRatio()	Constructs with no MCMove specified.
DataSourceAcceptanceRatio(MCMove move)

Method Summary

Modifier and Type	Method	Description
Unit	defaultIOUnit()
double	getDataAsScalar()	Returns the value of the acceptance ratio as currently kept by the MCMove class identified with setMove.
MCMove	getMove()
void	setMove(MCMove mv)	Sets the move for which the acceptance ratio is reported.

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

move

protected MCMove move

Constructor Detail

DataSourceAcceptanceRatio

public DataSourceAcceptanceRatio()

Constructs with no MCMove specified. Calls to getDataAsScalar will return Double.NaN until an MCMove is specified.

DataSourceAcceptanceRatio

public DataSourceAcceptanceRatio(MCMove move)

Method Detail

defaultIOUnit

public Unit defaultIOUnit()

Returns:

Decimal.UNIT

setMove

public void setMove(MCMove mv)

Sets the move for which the acceptance ratio is reported.

getMove

public MCMove getMove()

Returns:

the move for which the acceptance ratio is reported.

getDataAsScalar

public double getDataAsScalar()

Returns the value of the acceptance ratio as currently kept by the MCMove class identified with setMove.

Specified by:

getDataAsScalar in class DataSourceScalar