CD_KDParticleMerge.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_KDPARTICLEMERGE_H
#define CD_KDPARTICLEMERGE_H
 
// Std includes
#include <cstdint>
#include <functional>
#include <vector>
 
// Chombo includes
#include <Box.H>
#include <FArrayBox.H>
#include <RealVect.H>
 
// Our includes
#include <CD_ParticleSoA.H>
#include <CD_ParticleContainer.H>
#include <CD_ParticleManagement.H>
#include <CD_AmrMesh.H>
#include <CD_NamespaceHeader.H>
 
namespace ParticleManagement {
 
template <typename Packed>
using KDPayloadCombine = std::function<
  Packed(const Packed* a_payloads, const Real* a_weights, const std::size_t a_count)>;
 
namespace detail {
 
struct KDLeaf
{
  std::size_t lo;
 
  std::size_t hi;
 
  RealVect boxLo;
 
  RealVect boxHi;
};
 
template <typename Packed>
inline void
buildKDQuotaLeaves(std::vector<MergeParticle<Packed>>& a_particles,
                   FArrayBox&                          a_used,
                   std::vector<KDLeaf>&                a_leaves,
                   const int                           a_ppc,
                   const Real                          a_weightMedianCellWidths,
                   const RealVect&                     a_dx,
                   const RealVect&                     a_probLo,
                   const FArrayBox&                    a_cellCounts) noexcept;
 
template <typename T>
inline std::vector<T>
kdExchangeByRank(const std::vector<std::vector<T>>& a_sendByRank);
 
} // namespace detail
 
template <typename P,
          typename Packed,
          typename Traits = ParticleTraits<P>,
          typename Gather,
          typename Combine,
          typename Scatter,
          typename Allocator,
          typename PosValid,
          typename PatchRegular>
inline void
mergeKDCarve(ParticleContainer<P, Traits>& a_particles,
             EBAMRFAB&                     a_cellHistogram,
             EBAMRFAB&                     a_leafQuota,
             const AmrMesh&                a_amr,
             const int                     a_ppc,
             const Real                    a_weightMedianCellWidths,
             const KDPlacement             a_placement,
             const bool                    a_capWeights,
             const KDSplitPlacement        a_splitPlacement,
             const Gather&                 a_gather,
             const Combine&                a_combine,
             const Scatter&                a_scatter,
             const Allocator&              a_allocateID,
             const PosValid&               a_isPositionValid,
             const PatchRegular&           a_isPatchRegular);
 
template <typename P,
          typename Packed,
          typename Traits = ParticleTraits<P>,
          typename Gather,
          typename Combine,
          typename Scatter,
          typename Allocator,
          typename PosValid,
          typename PatchRegular>
inline void
mergeKDPatch(ParticleContainer<P, Traits>& a_particles,
             EBAMRFAB&                     a_cellHistogram,
             EBAMRFAB&                     a_leafQuota,
             const AmrMesh&                a_amr,
             const int                     a_ppc,
             const Real                    a_weightMedianCellWidths,
             const KDPlacement             a_placement,
             const bool                    a_capWeights,
             const KDSplitPlacement        a_splitPlacement,
             const Gather&                 a_gather,
             const Combine&                a_combine,
             const Scatter&                a_scatter,
             const Allocator&              a_allocateID,
             const PosValid&               a_isPositionValid,
             const PatchRegular&           a_isPatchRegular);
 
template <typename P,
          typename Packed,
          typename Traits = ParticleTraits<P>,
          typename Gather,
          typename Combine,
          typename Scatter,
          typename Allocator,
          typename PosValid,
          typename PatchRegular>
inline void
mergeKDInterior(ParticleContainer<P, Traits>& a_particles,
                ParticleContainer<P, Traits>& a_interior,
                EBAMRFAB&                     a_cellHistogram,
                EBAMRFAB&                     a_leafQuota,
                const AmrMesh&                a_amr,
                const int                     a_ppc,
                const Real                    a_weightMedianCellWidths,
                const KDPlacement             a_placement,
                const bool                    a_capWeights,
                const KDSplitPlacement        a_splitPlacement,
                const Gather&                 a_gather,
                const Combine&                a_combine,
                const Scatter&                a_scatter,
                const Allocator&              a_allocateID,
                const PosValid&               a_isPositionValid,
                const PatchRegular&           a_isPatchRegular);
 
} // namespace ParticleManagement
 
#include <CD_NamespaceFooter.H>
 
#include <CD_KDParticleMergeImplem.H>
 
#endif