Report.hpp

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 REPORTS_REPORT_H_INCLUDED
#define REPORTS_REPORT_H_INCLUDED
 
#include "aquagpusph/sphPrerequisites.hpp"
 
#include <vector>
#include "aquagpusph/Variable.hpp"
#include "aquagpusph/CalcServer/Tool.hpp"
 
namespace Aqua {
namespace CalcServer {
namespace Reports {

class Report : public Aqua::CalcServer::Tool
{
  public:
        Report(const std::string tool_name,
               const std::string fields,
               unsigned int ipf = 1,
               float fps = 0.f);

        virtual ~Report();

        virtual void setup();

        const std::string data(bool with_title = true, bool with_names = true, bool synced = false);

        inline cl_event getUserEvent() const { return _user_event; }

        inline void setUserEventStatus(cl_int status) const {
                cl_int err_code;
                // We need to store the user event so it is not getting overwritten
                // between clSetUserEventStatus() and clReleaseEvent()
                const cl_event user_event = getUserEvent();
                err_code = clSetUserEventStatus(user_event, status);
                CHECK_OCL_OR_THROW(err_code,
                        std::string("Failure setting as complete the tool \"") +
                        name() + "\".");
                err_code = clReleaseEvent(user_event);
                CHECK_OCL_OR_THROW(err_code,
                        std::string("Failure releasing the user event in tool \"") +
                        name() + "\".");
        }
 
  protected:
        void processFields(const std::string fields);

        std::vector<InputOutput::Variable*> variables() { return _vars; }

        bool mustUpdate();

        cl_event setCallback(const std::vector<cl_event> events,
                             void(CL_CALLBACK* cb)(cl_event, cl_int, void*));
 
  private:
        std::string _fields;
        unsigned int _ipf;
        float _fps;
        unsigned int _iter;
        float _t;
        std::string _data;
        std::vector<unsigned int> _vars_per_line;
        std::vector<InputOutput::Variable*> _vars;
        cl_event _user_event;
};
 
}
}
} // namespace
 
#endif // REPORTS_REPORT_H_INCLUDED