Helper to log performance data of AutoPas::computeInteractions() to a csv file for easier analysis. More...

Public Member Functions
	IterationLogger (const std::string &outputSuffix="", bool energyMeasurements=false)
	Constructor initializes the logger and sets the output file name.

	~IterationLogger ()
	Destructor drops the logger from the spd registry.

void	logIteration (const Configuration &configuration, size_t iteration, const std::string &functorName, bool inTuningPhase, long timeTuning, const IterationMeasurements &measurements) const
	Log the given arguments and the internal buffer to the csv file.

Detailed Description

Helper to log performance data of AutoPas::computeInteractions() to a csv file for easier analysis.

It uses an asynchronous spd logger to write a csv file named "AutoPas_iterationPerformance_<dateStamp>.csv".

By default logging the data is disabled. It can be enabled by setting the cmake variable AUTOPAS_LOG_ITERATIONS to ON.

Constructor & Destructor Documentation

autopas::IterationLogger::IterationLogger	(	const std::string &	outputSuffix = `""`,
		bool	energyMeasurements = `false`
	)

explicit

Constructor initializes the logger and sets the output file name.

Parameters

outputSuffix	Suffix for all output files produced by this class.
energyMeasurements	Should the logger include energy measurements?

void autopas::IterationLogger::logIteration	(	const Configuration &	configuration,
		size_t	iteration,
		const std::string &	functorName,
		bool	inTuningPhase,
		long	timeTuning,
		const IterationMeasurements &	measurements
	)		const

Log the given arguments and the internal buffer to the csv file.

Parameters

configuration
iteration
functorName
inTuningPhase	True if the logged iteration is in a tuning phase.
timeTuning	Time for finding the next configuration.
measurements	Struct that holds all measurements from a computeInteractions() iteration.

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