Recover the original id of each particle. More...

#include <CalcServer/UnSort.h>

Inheritance diagram for Aqua::CalcServer::UnSort:

Collaboration diagram for Aqua::CalcServer::UnSort:

Public Member Functions
	UnSort (const std::string name, const std::string var_name, const std::string permutations_name="id", bool once=false)

	~UnSort ()

void	setup ()

InputOutput::ArrayVariable *	input ()

cl_mem	output ()

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::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

Recover the original id of each particle.

This tool is not designed for the common usage but as an auxiliar tool for the savers or the MPI syncing, therefore it will not be selectable for the users.

Constructor & Destructor Documentation

◆ UnSort()

Aqua::CalcServer::UnSort::UnSort	(	const std::string	name,
		const std::string	var_name,
		const std::string	permutations_name = `"id"`,
		bool	once = `false`
	)

Constructor

Parameters

name	Tool name
var_name	Variable to unsort
permutations_name	Permutations to be considered
once	Run this tool just once. Useful to make initializations

◆ ~UnSort()

Aqua::CalcServer::UnSort::~UnSort ( )

Destructor.

Member Function Documentation

◆ _execute()

cl_event Aqua::CalcServer::UnSort::_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:

◆ input()

InputOutput::ArrayVariable * Aqua::CalcServer::UnSort::input ( )

inline

Get the input variable.

Returns: The variable to become sorted.

◆ output()

cl_mem Aqua::CalcServer::UnSort::output ( )

inline

Get the memory object where the unsorted data is stored.

Returns: The memory object where the unsorted data is stored.

◆ setup()

void Aqua::CalcServer::UnSort::setup ( )

virtual

Initialize the tool.