CD_LoadBalancing.H

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021-2026 SINTEF Energy Research
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#ifndef CD_LOADBALANCING_H
#define CD_LOADBALANCING_H
 
// Std includes
#include <cstdint>
 
// Our includes
#include <CD_MultiFluidIndexSpace.H>
#include <CD_BoxSorting.H>
#include <CD_Loads.H>
#include <CD_NamespaceHeader.H>
 
class LoadBalancing
{
public:
  template <class T>
  static void
  makeBalance(Vector<int>& a_ranks, const Vector<T>& a_loads, const Vector<Box>& a_boxes);
 
  template <class T>
  static void
  makeBalance(Vector<int>& a_ranks, Loads& a_rankLoads, const Vector<T>& a_boxLoads, const Vector<Box>& a_boxes);
 
  template <typename T>
  static void
  sort(Vector<Vector<Box>>& a_boxes, Vector<Vector<T>>& a_loads, const BoxSorting a_whichSorting);
 
  template <typename T>
  static void
  sort(Vector<Box>& a_boxes, Vector<T>& a_loads, const BoxSorting a_which);
 
  static void
  sort(Vector<Box>& a_boxes, const BoxSorting a_which);
 
  static void
  gatherBoxes(Vector<Box>& a_boxes);
 
  static void
  gatherLoads(Vector<Real>& a_loads);
 
  static void
  gatherLoads(Vector<int>& a_loads);
 
  static void
  gatherLoads(Vector<long>& a_loads);
 
  static void
  gatherBoxesAndLoads(Vector<Box>& a_boxes, Vector<int>& a_loads);
 
protected:
  template <class T>
  static std::vector<std::pair<Box, T>>
  packPairs(const Vector<Box>& a_boxes, const Vector<T>& a_loads);
 
  template <class T>
  static void
  unpackPairs(Vector<Box>& a_boxes, Vector<T>& a_loads, const std::vector<std::pair<Box, T>>& a_pairs);
 
  template <class T>
  static void
  standardSort(Vector<Box>& a_boxes, Vector<T>& a_loads);
 
  template <class T>
  static void
  shuffleSort(Vector<Box>& a_boxes, Vector<T>& a_loads);
 
  template <class T, int DIM>
  static void
  sortSFC(Vector<Box>&                                                    a_boxes,
          Vector<T>&                                                      a_loads,
          const std::function<uint64_t(const std::array<uint32_t, DIM>)>& a_sfcEncoder) noexcept;
 
  template <int DIM>
  static uint64_t
  mortonIndex(const std::array<uint32_t, DIM> a_coords) noexcept;
 
  template <int DIM>
  static uint64_t
  hilbertIndex(const std::array<uint32_t, DIM>& a_coords);
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_LoadBalancingImplem.H>
 
#endif