Base class for tools that has to evaluate a scalar expression. More...

#include <SetScalar.hpp>

Inheritance diagram for Aqua::CalcServer::ScalarExpression:

[legend]

Collaboration diagram for Aqua::CalcServer::ScalarExpression:

[legend]

Public Member Functions
	ScalarExpression (const std::string name, const std::string expr, const std::string type="float", bool once=false)
	Constructor.
	~ScalarExpression ()
	Destructor.
virtual void	setup ()
	Initialize the tool.
const std::string	getOutputType () const
	Get the output typesize.
void	setOutputType (const std::string type)
	Set the output typesize.
const std::string	getExpression () const
	Get the expression to evaluate.
const void *	getValue () const
	Get the stored output value.
cl_event	getUserEvent () const
	Get the user event generated by this tool to mark when is finished.
void	solve ()
	Evaluate the expression and store the value.
Public Member Functions inherited from Aqua::CalcServer::Tool
	Tool (const std::string tool_name, bool once=false)
virtual	~Tool ()
virtual void	execute ()
	Execute the tool measuring the elapsed time.
virtual Tool *	next_tool ()
Tool *	prev_tool () const
void	prev_tool (Tool *tool)
size_t	allocatedMemory () const
unsigned int	used_times () const
void	addElapsedTime (float elapsed_time)
	Add new data to the average and squared elapsed times.
float	elapsedTime (bool averaged=true) const
float	elapsedTimeVariance () const
float	elapsedTimeDeviation () const
virtual int	scope_modifier () const
std::vector< InputOutput::Variable * >	getInputDependencies () const
	Get the input depedencies of the tool.
std::vector< InputOutput::Variable * >	getOutputDependencies () const
	Get the output depedencies of the tool.
std::tuple< std::vector< InputOutput::Variable * >, std::vector< InputOutput::Variable * > >	getDependencies () const
	Get the depedencies of the tool.
cl_event	getEvent () const
	Get the tool event.
void	parent (Tool *tool)
	Set the tool parent.
Tool *	parent ()
	Get the tool parent.
Public Member Functions inherited from Aqua::CalcServer::Named
	Named (const std::string name)
	~Named ()
void	name (const std::string tool_name)
const std::string	name () const
	Get the name.
Public Member Functions inherited from Aqua::CalcServer::Profiler
	Profiler ()
	~Profiler ()
std::vector< Profile * >	substages () const
	Get the substages.

Protected Member Functions
virtual cl_event	_execute (const std::vector< cl_event > events)
virtual void	_solve ()
	Evaluate the expression and store the value.
Protected Member Functions inherited from Aqua::CalcServer::Tool
int	id_in_pipeline () const
std::string	varPrefix () const
	Produce a variable name prefix.
void	next_tool (Tool *tool)
void	allocatedMemory (size_t mem_size)
virtual cl_event	_execute (const UNUSED_PARAM std::vector< cl_event > events)
void	setDependencies (std::vector< std::string > inputs, std::vector< std::string > outputs)
	Set the depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > inputs, std::vector< InputOutput::Variable * > outputs)
	Set the depedencies of the tool.
void	setDependencies (std::vector< std::string > vars)
	Set the depedencies of the tool.
void	setInputDependencies (std::vector< std::string > vars)
	Set the reading depedencies of the tool.
void	setInputDependencies (std::vector< InputOutput::Variable * > vars)
	Set the reading depedencies of the tool.
void	setOutputDependencies (std::vector< std::string > vars)
	Set the writing depedencies of the tool.
void	setOutputDependencies (std::vector< InputOutput::Variable * > vars)
	Set the writing depedencies of the tool.
void	setDependencies (std::vector< InputOutput::Variable * > vars)
	Set the depedencies of the tool.
const std::vector< cl_event >	getEvents (dep_events which=dep_events::all) const
	Get the list of events that this tool shall wait for.
Protected Member Functions inherited from Aqua::CalcServer::Profiler
void	substages (std::vector< Profile * > instances)
	Set the tool substages.

Additional Inherited Members
Protected Types inherited from Aqua::CalcServer::Tool
enum	dep_events { in = 0x01 , out = 0x02 , all = 0x03 }
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

Base class for tools that has to evaluate a scalar expression.

This tool evaluates the expression asynchronously

Constructor & Destructor Documentation

◆ ScalarExpression()

Aqua::CalcServer::ScalarExpression::ScalarExpression	(	const std::string	name,
		const std::string	expr,
		const std::string	type = "float",
		bool	once = false )

Constructor.

Parameters

name	Tool name.
expr	Expression to evaluate.
type	Type of the output value. It can be modified later.
once	Run this tool just once. Useful to make initializations.

Here is the call graph for this function:

◆ ~ScalarExpression()

Aqua::CalcServer::ScalarExpression::~ScalarExpression ( )

Destructor.

Member Function Documentation

◆ _execute()

cl_event Aqua::CalcServer::ScalarExpression::_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 in Aqua::CalcServer::Set.

Here is the call graph for this function:

◆ _solve()

void Aqua::CalcServer::ScalarExpression::_solve ( )

protectedvirtual

Evaluate the expression and store the value.

This function can be overloaded to extent the functionality. E.g. to populate the output value on a variable

Reimplemented in Aqua::CalcServer::Assert, Aqua::CalcServer::Conditional, Aqua::CalcServer::If, Aqua::CalcServer::Set, and Aqua::CalcServer::SetScalar.

Here is the call graph for this function:

◆ getExpression()

const std::string Aqua::CalcServer::ScalarExpression::getExpression ( ) const

inline

Get the expression to evaluate.

Returns: The expression

◆ getOutputType()

const std::string Aqua::CalcServer::ScalarExpression::getOutputType ( ) const

inline

Get the output typesize.

Returns: The output typesize

◆ getUserEvent()

cl_event Aqua::CalcServer::ScalarExpression::getUserEvent ( ) const

inline

Get the user event generated by this tool to mark when is finished.

Returns: The event

Note: This event will be the same than Aqua::CalcServer::Tool::getEvent(), however we need it just in case the callback is executed before Aqua::CalcServer::Tool had time to store it (race condition)

◆ getValue()

const void * Aqua::CalcServer::ScalarExpression::getValue ( ) const

inline

Get the stored output value.

Returns: The output value memory

◆ setOutputType()

void Aqua::CalcServer::ScalarExpression::setOutputType ( const std::string type )

Set the output typesize.

Returns: The output typesize

Warning: This function will reallocate memory, discarding stored results from eventual previous evaluations

Here is the call graph for this function:

◆ setup()

void Aqua::CalcServer::ScalarExpression::setup ( )

virtual

Initialize the tool.

Reimplemented from Aqua::CalcServer::Tool.

Reimplemented in Aqua::CalcServer::Conditional, Aqua::CalcServer::Set, and Aqua::CalcServer::SetScalar.

Here is the call graph for this function:

◆ solve()

void Aqua::CalcServer::ScalarExpression::solve ( )

Evaluate the expression and store the value.

Also the execution elapsed time is measured and the event is set as completed.

This function is actually a closure for _solve() function, that can be overloaded to extent the functionality. E.g. to populate the output value on a variable

Here is the call graph for this function:

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

/home/pepe/SPH/Code/aquagpusph/aquagpusph/CalcServer/SetScalar.hpp
/home/pepe/SPH/Code/aquagpusph/aquagpusph/CalcServer/SetScalar.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScalarExpression()

◆ ~ScalarExpression()

Member Function Documentation

◆ _execute()

◆ _solve()

◆ getExpression()

◆ getOutputType()

◆ getUserEvent()

◆ getValue()

◆ setOutputType()

◆ setup()

◆ solve()