AbstractLoadBalancing.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
 
#include <map>
 
#include "Blacklist.h"
#include "Configuration.h"
#include "CostMetrics.h"
#include "Statistics.h"
#include "peano4/parallel/Node.h"
#include "tarch/logging/Log.h"
#include "tarch/mpi/mpi.h"
 
 
namespace toolbox {
  namespace loadbalancing {
    class AbstractLoadBalancing;
  } // namespace loadbalancing
} // namespace toolbox
 
 
class toolbox::loadbalancing::AbstractLoadBalancing {
public:
  static constexpr int NoHeaviestTreeAvailable = -1;
 
  AbstractLoadBalancing(Configuration* configuration, CostMetrics* costMetrics);
 
  virtual ~AbstractLoadBalancing();
 
 
  virtual std::string toString() const;
 
 
  virtual void enable(bool);
 
 
  virtual bool hasSplitRecently() const;
 
 
  bool isEnabled(bool globally) const;
 
 
  virtual int getGlobalNumberOfTrees() const;
 
 
  virtual bool hasStagnated() const;
 
 
  virtual void finishSimulation();
 
 
  virtual void finishStep() = 0;
 
  void setConfigurationAndMetricsNullWithoutDelete();
 
protected:
  static tarch::logging::Log _log;
 
  Blacklist _blacklist;
 
  Statistics _statistics;
 
  Configuration* _configuration;
 
  CostMetrics* _costMetrics;
 
  State _state;
 
  bool fitsIntoMemory(State state) const;
 
 
  bool isInterRankBalancingBad() const;
 
 
  bool isIntraRankBalancingBad() const;
 
 
  bool areRanksUnemployed() const;
 
  double getWeightOfHeaviestLocalSpacetree() const;
 
  int getIdOfHeaviestLocalSpacetree() const;
 
 
  int getIdOfHeaviestLocalSpacetree(double tolerance) const;
};
 
std::ostream& operator<<(std::ostream& out, const toolbox::loadbalancing::AbstractLoadBalancing& balancing);