MultiThreadedProcess.hpp

Go to the documentation of this file.

// This file is part of GranOO, a workbench for DEM simulation.
//
// Author(s)    : - Damien Andre       IRCER/UNILIM, Limoges France
//                  <damien.andre@unilim.fr>
//                - Jean-luc Charles   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jean-luc.charles@ensam.eu>
//                - Jeremie Girardot   Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <jeremie.girardot@ensam.eu>
//                - Cedric Hubert      LAMIH/UPHF, Valenciennes France
//                  <cedric.hubert@uphf.fr>
//                - Ivan Iordanoff     Arts et Metiers ParisTech, CNRS, I2M, Bordeaux France
//                  <ivan.iordanoff@ensam.eu>
//
// Copyright (C) 2008-2019 D. Andre, JL. Charles, J. Girardot, C. Hubert, I. Iordanoff
//
// This program 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.
//
// This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
#ifndef _GranOO_libCore_MultiThreadedProcess_hpp_
#define _GranOO_libCore_MultiThreadedProcess_hpp_
 
#include <thread>
#include <ctime>
#include <string>
#include <vector>
#include <functional>
 
// This is a macro to deal with all multiThreaded Processes in GranOO
 
#include <boost/chrono/thread_clock.hpp>
 
 
namespace GranOO3
{
  namespace Core
  {
    class MultiThreadedProcess
    {
    public:
      MultiThreadedProcess(const std::string & id = std::string(""));
      virtual ~MultiThreadedProcess();
      virtual void parse_xml();
 
      // This virtual method must be defined in all PlugIns you want to run on multiple cores (i.e. "GranOO3/PlugIn/ApplyBondLoad.hpp")
      virtual void run_multi_thread_process(size_t startIndex, size_t stopIndex, size_t threadRank = -1) = 0;
 
      void init(size_t totalItemNumberToProcess, bool resetTimeAccumulator = true);
      void run(size_t totalItemNumberToProcess);
 
      size_t get_total_item_number_to_process() const {return _total_item_number_to_process;}
      unsigned int get_total_number_of_thread() const {return _total_number_of_thread;}
 
    private:
      MultiThreadedProcess(const MultiThreadedProcess &); // Not allowed
      void operator=(const MultiThreadedProcess &);       // Not allowed
 
    private:
      const std::string _ID;
      size_t _total_item_number_to_process;
      unsigned int _total_number_of_thread;
      std::vector<std::function<void (void)> > _exec_function_vector;
    };
 
  }
}
 
#endif