LoadBalancingConfiguration.h

Go to the documentation of this file.

// This file is part of the ExaHyPE2 project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
 
#include "tarch/logging/Log.h"
#include "toolbox/loadbalancing/Configuration.h"
 
 
namespace exahype2 {
  class LoadBalancingConfiguration;
}
 
 
class exahype2::LoadBalancingConfiguration: public toolbox::loadbalancing::Configuration {
  private:
    static tarch::logging::Log  _log;
 
    const double   _loadBalancingQuality;
    const int      _minSizeOfTree;
    const bool     _assumePeriodicBoundaryConditions;
    const int      _maxNumberOfTreesThroughoutInitialDistribution;
    const int      _maxNumberOfTrees;
    const peano4::SplitInstruction::Mode _mode;
 
    int translateSetMaxNumberOfTreesIntoRealNumberOfTrees(int value) const;
 
  public:
    static constexpr int  UseNumberOfThreads         = -1;
    static constexpr int  UseTwiceTheNumberOfThreads = -2;
 
    LoadBalancingConfiguration(
      double loadBalancingQuality=0.9,
      int    minSizeOfTree = 0,
      bool   assumePeriodicBoundaryConditions = false,
      int    maxNumberOfTreesThroughoutInitialDistribution=UseNumberOfThreads,
      int    maxNumberOfTrees=UseTwiceTheNumberOfThreads,
      peano4::SplitInstruction::Mode mode = peano4::SplitInstruction::Mode::BottomUp
    );
 
    virtual ~LoadBalancingConfiguration() = default;
 
    virtual bool makeSplitDependOnMemory(toolbox::loadbalancing::State state) override;
 
    virtual int getMaxLocalTreesPerRank(toolbox::loadbalancing::State state) override;
 
    virtual double getWorstCaseBalancingRatio(toolbox::loadbalancing::State state) override;
 
    virtual int getMinTreeSize(toolbox::loadbalancing::State state) override;
 
    virtual std::string toString() const override;
 
    virtual peano4::SplitInstruction::Mode getMode(toolbox::loadbalancing::State state) override;
};