load_balancer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009-2015:  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.
 */
 
#ifndef __H__UG__load_balancer__
#define __H__UG__load_balancer__
 
#include <vector>
#include "lib_grid/multi_grid.h"
#include "lib_grid/algorithms/serialization.h"
#include "common/util/table.h"
#include "partitioner.h"
 
#ifdef UG_PARALLEL
  #include "pcl/pcl_process_communicator.h"
#endif
 
 
namespace ug{
 
 
class LoadBalancer{
  public:
    LoadBalancer();
 
    virtual ~LoadBalancer();
 
    virtual void set_grid(MultiGrid* mg);
 
    virtual void enable_vertical_interface_creation(bool enable);
 
    virtual void set_partitioner(SPPartitioner partitioner);
 
 
    virtual void set_balance_weights(SPBalanceWeights balanceWeights);
 
 
//    virtual void set_connection_weights(SmartPtr<IConnectionWeights> conWeights);
 
//  /// Inserts a new distribution level on which the grid may be redistributed
//  /** Use this method to map a region of levels to a subset of the active processes.
//   * Very useful for hierarchical distribution. Elements between the given level
//   * and the level specified in the next cut are distributed between the given
//   * number of processes only.
//   * The new level has to lie above the level added before.*/
//    virtual void add_distribution_level(size_t lvl, size_t numProcsPerProc);
 
    virtual void set_next_process_hierarchy(SPProcessHierarchy procHierarchy);
 
 
    virtual void set_balance_threshold(number threshold);
 
    virtual void set_element_threshold(size_t threshold);
 
//  /// returns the quality of the current distribution
//    virtual number distribution_quality();
 
 
    virtual bool rebalance();
 
 
    virtual number estimate_distribution_quality(std::vector<number>* pLvlQualitiesOut);
    number estimate_distribution_quality();
 
    virtual void add_serializer(SPVertexDataSerializer cb)  {m_serializer.add(cb);}
    virtual void add_serializer(SPEdgeDataSerializer cb)  {m_serializer.add(cb);}
    virtual void add_serializer(SPFaceDataSerializer cb)  {m_serializer.add(cb);}
    virtual void add_serializer(SPVolumeDataSerializer cb)  {m_serializer.add(cb);}
    virtual void add_serializer(SPGridDataSerializer cb)  {m_serializer.add(cb);}
 
    bool problems_occurred();
 
    void create_quality_record(const char* label);
    void print_quality_records() const;
    void print_last_quality_record() const;
 
  private:
    template <class TElem>
    number estimate_distribution_quality_impl(std::vector<number>* pLvlQualitiesOut);
 
    MultiGrid*      m_mg;
    number        m_balanceThreshold;
    size_t        m_elementThreshold;
    SPProcessHierarchy  m_processHierarchy;
    SPPartitioner   m_partitioner;
    SPBalanceWeights  m_balanceWeights;
//    SPConnectionWeights m_connectionWeights;
    GridDataSerializationHandler  m_serializer;
    StringStreamTable m_qualityRecords;
    bool m_createVerticalInterfaces;
};
 
} // end of namespace
 
#endif