Correlation measurement for models with diagonal interactions. More...

Inheritance diagram for XYZMeasurementCorrelation:

Collaboration diagram for XYZMeasurementCorrelation:

Public Member Functions
	XYZMeasurementCorrelation (const std::string &outfile, const float minCutoff, const float maxCutoff, const bool defer)
	Construct a new XYZMeasurementCorrelation object to measure correlations. More...

	~XYZMeasurementCorrelation ()
	Destroy the XYZMeasurementCorrelation object.

void	takeMeasurement (const EffectiveAction &state, const bool isMasterTask) const override
	Take measurement. More...

Public Member Functions inherited from Measurement
	Measurement (const std::string &outfile, const float minCutoff, const float maxCutoff, const bool isDeferred)
	Construct a non load managed Measurement object. More...

virtual	~Measurement ()
	Virtual destructor.

std::string	outfile () const
	Return the filename of the output file. More...

float	minCutoff () const
	Return the minimum cutoff above which the measurement protocol is invoked. More...

float	maxCutoff () const
	Return the maximum cutoff value below which the measurement protocol is invoked. More...

bool	isDeferred () const
	Query whether the measurement protocol is a deferred measurement. More...

bool	isLoadManaged () const
	Query whether the measurement protocol is load managed. More...

std::vector< HMP::StackIdentifier >	getLoadManagedStacks () const
	Return a list of LoadManager::DataStack ids to compute in the FrgCore::computeStep() function. More...

Additional Inherited Members
Protected Member Functions inherited from Measurement
	Measurement (const std::string &outfile, const float minCutoff, const float maxCutoff, const bool isDeferred, const bool isLoadManaged)
	Construct a new Measurement object. More...

Protected Attributes inherited from Measurement
bool	_isLoadManaged
	If set to true, the measurement protocol is considered to be load managed. Derived classes should initialize this variable with the desired value in the constructor.

std::vector< HMP::StackIdentifier >	_loadManagedStacks
	Contains a list of load managed stack identifiers. Derived classis should initialize this list in the constructor.

Detailed Description

Correlation measurement for models with diagonal interactions.

Constructor & Destructor Documentation

XYZMeasurementCorrelation::XYZMeasurementCorrelation	(	const std::string &	outfile,
		const float	minCutoff,
		const float	maxCutoff,
		const bool	defer
	)

Construct a new XYZMeasurementCorrelation object to measure correlations.

Parameters

outfile	Filename where to write the result file.
minCutoff	Minimum cutoff above which to invoke the measurement protocol.
maxCutoff	Maximum cutoff below which to invoke the measurement protocol.
defer	If set to true, measurements are deferred to the postprocessing stage.

void XYZMeasurementCorrelation::takeMeasurement	(	const EffectiveAction &	state,
		const bool	isMasterTask
	)		const

overridevirtual

Take measurement.

Parameters

state	Effective action object to perform the measurement on.
isMasterTask	If set to true, the function call should be responsible for writing the output file.

Implements Measurement.

The documentation for this class was generated from the following files: