domain_load_balancer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-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__domain_load_balancer__
#define __H__UG__domain_load_balancer__
 
#include "lib_disc/domain.h"  // for DomainInfo
#include "lib_grid/refinement/refiner_interface.h"
#include "lib_grid/parallelization/load_balancer.h"
#include "lib_grid/parallelization/load_balancer_util.h"
 
namespace ug{
 
template <class TDomain>
SPProcessHierarchy
CreateProcessHierarchy(TDomain& dom, size_t minNumElemsPerProcPerLvl,
             size_t maxNumRedistProcs, size_t maxNumProcs,
             int minDistLvl, int maxLevelsWithoutRedist)
{
  return CreateProcessHierarchy(dom, minNumElemsPerProcPerLvl,
            maxNumRedistProcs, maxNumProcs, minDistLvl,
            maxLevelsWithoutRedist, NULL);
}
 
template <class TDomain>
SPProcessHierarchy
CreateProcessHierarchy(TDomain& dom, size_t minNumElemsPerProcPerLvl,
             size_t maxNumRedistProcs, size_t maxNumProcs,
             int minDistLvl, int maxLevelsWithoutRedist,
             IRefiner* refiner)
{
  const DomainInfo& domInf = dom.domain_info();
  std::vector<size_t> numElemsOnLvl;
  numElemsOnLvl.reserve(domInf.num_levels());
  for(size_t i = 0; i < domInf.num_levels(); ++i)
    numElemsOnLvl.push_back(domInf.num_elements_on_level(i));
 
  if(numElemsOnLvl.empty()){
    return ProcessHierarchy::create();
  }
 
  if(refiner){
    std::vector<int>  numMarked;
    int elemFactor = 1;
    if(dom.get_dim() == 1){
      refiner->num_marked_edges(numMarked);
      elemFactor = 2;
    }
    else if(dom.get_dim() == 2){
      refiner->num_marked_faces(numMarked);
      elemFactor = 4;
    }
    else if(dom.get_dim() == 3){
      refiner->num_marked_volumes(numMarked);
      elemFactor = 8;
    }
 
    if(numMarked.size() < numElemsOnLvl.size())
      numMarked.resize(numElemsOnLvl.size(), 0);
 
    if(numMarked[numElemsOnLvl.size() - 1] > 0)
      numElemsOnLvl.resize(numElemsOnLvl.size() + 1, 0);
 
    for(size_t i = 0; i < numElemsOnLvl.size(); ++i){
      if(numMarked[i] > 0){
        numElemsOnLvl[i+1] += numMarked[i] * elemFactor;
      }
    }
  }
 
  return CreateProcessHierarchy(&numElemsOnLvl.front(), numElemsOnLvl.size(),
                  minNumElemsPerProcPerLvl, maxNumRedistProcs,
                  maxNumProcs, minDistLvl, maxLevelsWithoutRedist);
}
 
template <class TDomain>
class DomainLoadBalancer : public LoadBalancer
{
  typedef LoadBalancer  base_class;
 
  public:
    using base_class::add_serializer;
 
    DomainLoadBalancer(SmartPtr<TDomain> dom) : m_dom(dom)
    {
      base_class::set_grid(dom->grid().get());
 
      base_class::add_serializer(
        GeomObjAttachmentSerializer<Vertex, typename TDomain::position_attachment_type>::
                create(*dom->grid(), dom->position_attachment()));
 
      base_class::add_serializer(
        SubsetHandlerSerializer::create(*dom->subset_handler()));
 
      std::vector<std::string> additionalSHNames = dom->additional_subset_handler_names();
      for(size_t i = 0; i < additionalSHNames.size(); ++i){
        SmartPtr<ISubsetHandler> sh = dom->additional_subset_handler(additionalSHNames[i]);
        if(sh.valid()){
          base_class::add_serializer(SubsetHandlerSerializer::create(*sh));
        }
      }
    }
 
  private:
    SmartPtr<TDomain> m_dom;
};
 
 
template <class TDomain, class TPartitioner>
class DomainPartitioner : public TPartitioner{
  public:
    DomainPartitioner(TDomain& dom){
      TPartitioner::set_grid(dom.grid().get(), dom.position_attachment());
    }
};
 
template <class TDomain, class TBalanceWeights>
class DomainBalanceWeights : public TBalanceWeights{
  public:
    DomainBalanceWeights(TDomain& dom){
      TBalanceWeights::set_grid(dom.grid().get(), dom.position_attachment());
    }
};
 
template <class TDomain, class TCommunicationCostWeights>
class DomainCommunicationCostWeights : public TCommunicationCostWeights{
  public:
    DomainCommunicationCostWeights(TDomain& dom){
      TCommunicationCostWeights::set_grid(dom.grid().get(), dom.position_attachment());
    }
};
 
}// end of namespace
 
#endif