process_hierarchy.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
// NOTE: Classes in this file were originally defined in 'load_balancer.h'
#ifndef __H__UG_process_hierarchy
#define __H__UG_process_hierarchy
 
#include <vector>
#include "common/util/variant.h"
 
#ifdef UG_PARALLEL
  #include "pcl/pcl_process_communicator.h"
#endif
 
namespace ug{
 
class ProcessHierarchy;
typedef SmartPtr<ProcessHierarchy> SPProcessHierarchy;
typedef ConstSmartPtr<ProcessHierarchy> ConstSPProcessHierarchy;
 
 
 
class ProcessHierarchy{
  public:
    static SPProcessHierarchy create()  {return SPProcessHierarchy(new ProcessHierarchy);}
    ~ProcessHierarchy();
 
  //todo: add a proc list for more sophisticated hierarchy levels
    void add_hierarchy_level(size_t gridLvl, size_t numProcsPerProc);
 
    bool empty() const;
    size_t num_hierarchy_levels() const;
    size_t num_global_procs_involved(size_t hierarchyLevel) const;
    size_t grid_base_level(size_t hierarchyLevel) const;
    size_t hierarchy_level_from_grid_level(size_t gridLevel) const;
 
    pcl::ProcessCommunicator global_proc_com(size_t hierarchyLevel) const;
 
    //pcl::ProcessCommunicator cluster_proc_com(size_t hierarchyLevel);
    const std::vector<int>& cluster_procs(size_t hierarchyLevel) const;
 
    std::string to_string() const;
 
 
    void add_partition_hint(int hlvl, const std::string& name, const Variant& value);
 
 
    bool partition_hint(Variant& valOut, int hlvl, const std::string& name) const;
 
  protected:
    typedef std::map<std::string, Variant>  PartitionHintMap;
 
    struct HLevelInfo{
      pcl::ProcessCommunicator globalCom;
      //pcl::ProcessCommunicator clusterCom;
      std::vector<int> clusterProcs;
      size_t gridLvl;
      size_t numGlobalProcsInUse;
      PartitionHintMap  m_partitionHints;
    };
 
    HLevelInfo& get_hlevel_info(size_t lvl)       {return m_levels.at(lvl);}
    const HLevelInfo& get_hlevel_info(size_t lvl) const {return m_levels.at(lvl);}
 
//    virtual pcl::ProcessCommunicator
//      create_cluster_communicator(size_t hlvl, size_t gridLvl, size_t numProcsPerProc);
    void init_cluster_procs(std::vector<int>& clusterProcs, size_t hlvl,
                size_t numProcsPerProc);
 
  private:
    std::vector<HLevelInfo> m_levels;
};
 
  
}// end of namespace
 
#endif  //__H__UG_process_hierarchy