Tool.h

Go to the documentation of this file.

/*
 *  This file is part of AQUAgpusph, a free CFD program based on SPH.
 *  Copyright (C) 2012  Jose Luis Cercos Pita <jl.cercos@upm.es>
 *
 *  AQUAgpusph is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  AQUAgpusph is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with AQUAgpusph.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef TOOL_H_INCLUDED
#define TOOL_H_INCLUDED
 
#include <sphPrerequisites.h>
#include <Variable.h>
#include <math.h>
#include <vector>
 
namespace Aqua {
namespace CalcServer {
 
class Tool
{
  public:
        Tool(const std::string tool_name, bool once = false);
 
        virtual ~Tool();
 
        void name(const std::string tool_name) { _name = tool_name; };
 
        const std::string name() { return _name; }
 
        virtual void setup();
 
        virtual void execute();
 
        virtual Tool* next_tool() { return _next_tool; }
 
        size_t allocatedMemory() const { return _allocated_memory; }
 
        unsigned int used_times() const { return _n_iters; }
 
        float elapsedTime(bool averaged = true) const
        {
                if (!averaged)
                        return _elapsed_time;
                return _average_elapsed_time;
        }
 
        float elapsedTimeVariance() const
        {
                return _squared_elapsed_time - pow(_average_elapsed_time, 2);
        }
 
        float elapsedTimeDeviation() const { return sqrt(elapsedTimeVariance()); }
 
        virtual const int scope_modifier() { return 0; }
 
  protected:
        int id_in_pipeline();
 
        void next_tool(Tool* tool) { _next_tool = tool; }
 
        void allocatedMemory(size_t mem_size) { _allocated_memory = mem_size; }
 
        virtual cl_event _execute(const std::vector<cl_event> events)
        {
                return NULL;
        }
 
        void addElapsedTime(float elapsed_time);
 
        void setDependencies(std::vector<std::string> var_names);
 
        void setDependencies(std::vector<InputOutput::Variable*> vars);
 
        const std::vector<InputOutput::Variable*> getDependencies();
 
        static std::vector<cl_kernel> compile(const std::string source,
                                              const std::vector<std::string> names,
                                              const std::string flags = "");
 
        static cl_kernel compile_kernel(const std::string source,
                                        const std::string kernel_name,
                                        const std::string flags = "");
 
  private:
        const std::vector<cl_event> getEvents();
 
        std::string _name;
 
        bool _once;
 
        Tool* _next_tool;
 
        size_t _allocated_memory;
 
        unsigned int _n_iters;
 
        float _elapsed_time;
 
        float _average_elapsed_time;
 
        float _squared_elapsed_time;
 
        std::vector<InputOutput::Variable*> _vars;
 
        std::vector<cl_event> _events;
};
 
}
} // namespace
 
#endif // TOOL_H_INCLUDED