CD_ParticleManagement.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_PARTICLEMANAGEMENT_H
#define CD_PARTICLEMANAGEMENT_H
 
// Std includes
#include <memory>
#include <vector>
 
// Chombo includes
#include <RealVect.H>
#include <List.H>
 
// Our includes
#include <CD_KDNode.H>
#include <CD_CellInfo.H>
#include <CD_NamespaceHeader.H>
 
namespace ParticleManagement {
 
  template <class P>
  using ParticleMerger = std::function<
    void(List<P>& a_particles, const CellInfo& a_cellInfo, const int a_numTargetParticles)>;
 
  template <class P>
  using BinaryParticleReconcile = std::function<void(P& p1, P& p2, const P& p0)>;
 
  template <class P, Real& (P::*weight)(), const RealVect& (P::*position)() const>
  static inline void
  partitionAndSplitEqualWeightKD(
    KDNode<P>&                       a_node,
    const BinaryParticleReconcile<P> a_particleReconcile = [](P& p1, P& p2, const P& p0) -> void {
    }) noexcept;
 
  template <class P, Real& (P::*weight)(), const RealVect& (P::*position)() const>
  static inline std::vector<std::shared_ptr<KDNode<P>>>
  recursivePartitionAndSplitEqualWeightKD(
    typename KDNode<P>::ParticleList& a_inputParticles,
    const int                         a_maxLeaves,
    const BinaryParticleReconcile<P>  a_particleReconcile = [](P& p1, P& p2, const P& p0) -> void {
    }) noexcept;
 
  template <typename P, typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline void
  removePhysicalParticles(List<P>& a_particles, const T a_numPhysPartToRemove) noexcept;
 
  template <typename P>
  static inline void
  deleteParticles(List<P>& a_particles, const Real a_weightThresh) noexcept;
 
  template <typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline std::vector<T>
  partitionParticleWeights(const T a_numPhysicalParticles, const T a_maxCompParticles) noexcept;
 
  template <typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline T
  partitionParticles(const T a_numParticles);
 
  template <typename P, typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline void
  drawRandomParticles(List<P>& a_particles, const T a_numParticles, const std::function<RealVect()>& a_distribution);
 
  template <typename P, typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline void
  drawSphereParticles(List<P>&        a_particles,
                      const T         a_numParticles,
                      const RealVect& a_center,
                      const Real      a_radius) noexcept;
 
  template <typename P, typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline void
  drawBoxParticles(List<P>&        a_particles,
                   const T         a_numParticles,
                   const RealVect& a_loCorner,
                   const RealVect& a_hiCorner) noexcept;
 
  template <typename P, typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
  static inline void
  drawGaussianParticles(List<P>&        a_particles,
                        const T         a_numParticles,
                        const RealVect& a_center,
                        const Real      a_radius) noexcept;
 
} // namespace ParticleManagement
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ParticleManagementImplem.H>
 
#endif