Aqua::CalcServer::Reports::TabFile Class Reference

Runtime output file. More...

#include <CalcServer/TabFile.h>

Inheritance diagram for Aqua::CalcServer::Reports::TabFile:

Collaboration diagram for Aqua::CalcServer::Reports::TabFile:

Public Member Functions
	TabFile (const std::string tool_name, const std::string fields, const std::string output_file)
	Constructor.
	~TabFile ()
	Destructor.
void	setup ()
	Initialize the tool.
Public Member Functions inherited from Aqua::CalcServer::Reports::Report
	Report (const std::string tool_name, const std::string fields, unsigned int ipf=1, float fps=0.f)
	Constructor.
virtual	~Report ()
	Destructor.
virtual void	setup ()
	Initialize the tool.
const std::string	data (bool with_title=true, bool with_names=true)
	Return the text string of the data to be printed.
Public Member Functions inherited from Aqua::CalcServer::Tool
	Tool (const std::string tool_name, bool once=false)
virtual	~Tool ()
void	name (const std::string tool_name)
const std::string	name ()
virtual void	setup ()
virtual void	execute ()
	Execute the tool measuring the elapsed time.
virtual Tool *	next_tool ()
size_t	allocatedMemory () const
unsigned int	used_times () const
float	elapsedTime (bool averaged=true) const
float	elapsedTimeVariance () const
float	elapsedTimeDeviation () const
virtual const int	scope_modifier ()

Protected Member Functions
cl_event	_execute (const std::vector< cl_event > events)
Protected Member Functions inherited from Aqua::CalcServer::Reports::Report
void	processFields (const std::string fields)
	Compute the fields by lines.
std::vector< InputOutput::Variable * >	variables ()
	Get the variables list.
bool	mustUpdate ()
	Check if an output must be performed.
Protected Member Functions inherited from Aqua::CalcServer::Tool
int	id_in_pipeline ()
void	next_tool (Tool *tool)
void	allocatedMemory (size_t mem_size)
virtual cl_event	_execute (const std::vector< cl_event > events)
void	addElapsedTime (float elapsed_time)
	Add new data to the average and squared elapsed times.
void	setDependencies (std::vector< std::string > var_names)
	Set the depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > vars)
	Set the depedencies of the tool.
const std::vector< InputOutput::Variable * >	getDependencies ()
	Get the depedencies of the tool.

Additional Inherited Members
Static Protected Member Functions inherited from Aqua::CalcServer::Tool
static std::vector< cl_kernel >	compile (const std::string source, const std::vector< std::string > names, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.
static cl_kernel	compile_kernel (const std::string source, const std::string kernel_name, const std::string flags="")
	Compile an OpenCL source code and generate the corresponding kernel.

Detailed Description

Runtime output file.

A runtime output is an output which is created during the code execution, featured by:

1. Low amount of involved memory
2. Relatively low computational cost Thus, it can be safely computed and printed quite often

Constructor & Destructor Documentation

TabFile()

Aqua::CalcServer::Reports::TabFile::TabFile	(	const std::string	tool_name,
		const std::string	fields,
		const std::string	output_file
	)

Constructor.

Parameters

tool_name	Tool name
fields	Fields to be printed The fields are separated by commas or semicolons, and the spaces are just ignored The semicolons will also force a line break in the report
output_file	File to be written. Several scape strings can be used, as described in Aqua::newFilePath()

Remarks

The output file will be cleared.

Here is the call graph for this function:

~TabFile()

Aqua::CalcServer::Reports::TabFile::~TabFile

(

)

Destructor.

Member Function Documentation

_execute()

cl_event Aqua::CalcServer::Reports::TabFile::_execute ( const std::vector< cl_event >  events )

protectedvirtual

Execute the tool

Parameters

events

List of events that shall be waited before safe execution

Returns

OpenCL event to be waited before accessing the dependencies

Reimplemented from Aqua::CalcServer::Tool.

Here is the call graph for this function:

setup()

void Aqua::CalcServer::Reports::TabFile::setup ( )

virtual

Initialize the tool.

Reimplemented from Aqua::CalcServer::Reports::Report.

Here is the call graph for this function:

---

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

• /home/pepe/SPH/Code/aquagpusph/include/CalcServer/Reports/TabFile.h
• /home/pepe/SPH/Code/aquagpusph/src/CalcServer/Reports/TabFile.cpp