AQUAgpusph 5.0.4
Loading...
Searching...
No Matches
Aqua::CalcServer::UnSort Class Reference

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

#include <UnSort.hpp>

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::ArrayVariableinput ()
cl_mem output ()
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 Toolnext_tool ()
Toolprev_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.
Toolparent ()
 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)
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

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
nameTool name
var_nameVariable to unsort
permutations_namePermutations to be considered
onceRun this tool just once. Useful to make initializations
Here is the call graph for this function:

◆ ~UnSort()

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

Destructor.

Member Function Documentation

◆ _execute()

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

Execute the tool

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

◆ 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.

Reimplemented from Aqua::CalcServer::Tool.

Here is the call graph for this function:

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