A tool consisting in an OpenCL kernel execution. The variables used in the OpenCL kernel are automatically detected. More...

#include <CalcServer/Kernel.h>

Inheritance diagram for Aqua::CalcServer::Kernel:

[legend]

Collaboration diagram for Aqua::CalcServer::Kernel:

[legend]

Public Member Functions
	Kernel (const std::string tool_name, const std::string kernel_path, const std::string entry_point="entry", const std::string n="", bool once=false)
virtual	~Kernel ()
void	setup ()
const std::string	path ()
size_t	workGroupSize () const
size_t	globalWorkSize () const
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
cl_event	_execute (const std::vector< cl_event > events)
void	make (const std::string entry_point="entry", const std::string flags="", const std::string header="")
void	variables ()
void	computeGlobalWorkSize ()
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

A tool consisting in an OpenCL kernel execution. The variables used in the OpenCL kernel are automatically detected.

Constructor & Destructor Documentation

◆ Kernel()

Aqua::CalcServer::Kernel::Kernel	(	const std::string	tool_name,
		const std::string	kernel_path,
		const std::string	entry_point = "entry",
		const std::string	n = "",
		bool	once = false )

Constructor.

Parameters

tool_name	Tool name.
kernel_path	Kernel path.
n	Number of threads to launch. An empty string to autocompute it from the length of the output array variables
once	Run this tool just once. Useful to make initializations.

Here is the call graph for this function:

◆ ~Kernel()

Aqua::CalcServer::Kernel::~Kernel ( )

virtual

Destructor

Member Function Documentation

◆ _execute()

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

protected

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

Here is the call graph for this function:

◆ computeGlobalWorkSize()

void Aqua::CalcServer::Kernel::computeGlobalWorkSize ( )

protected

Compute the global work size

Here is the call graph for this function:

◆ globalWorkSize()

size_t Aqua::CalcServer::Kernel::globalWorkSize ( ) const

inline

Get the work group size

Returns: Work group size

◆ make()

void Aqua::CalcServer::Kernel::make	(	const std::string	entry_point = "entry",
		const std::string	flags = "",
		const std::string	header = "" )

protected

Compile the OpenCL program

Parameters

entry_point	Program entry point method.
flags	Compiling additional flags.
header	Header to be append at the start of the source code.

Returns: false if all gone right, true otherwise.

Here is the call graph for this function:

◆ path()

const std::string Aqua::CalcServer::Kernel::path ( )

inline

Get the kernel file path.

Returns: Tool kernel file path.

◆ setup()

void Aqua::CalcServer::Kernel::setup ( )

virtual

Initialize the tool.

Returns: false if all gone right, true otherwise.

Reimplemented from Aqua::CalcServer::Tool.

Here is the call graph for this function:

◆ variables()

void Aqua::CalcServer::Kernel::variables ( )

protected

Compute the variables required by the program

Returns: false if all gone right, true otherwise.

Here is the call graph for this function:

◆ workGroupSize()

size_t Aqua::CalcServer::Kernel::workGroupSize ( ) const

inline

Get the work group size

Returns: Work group size

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Kernel()

◆ ~Kernel()

Member Function Documentation

◆ _execute()

◆ computeGlobalWorkSize()

◆ globalWorkSize()

◆ make()

◆ path()

◆ setup()

◆ variables()

◆ workGroupSize()