CD_KDNode.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_KDNODE_H
#define CD_KDNODE_H
 
// Std includes
#include <memory>
#include <vector>
 
// Chombo includes
#include <RealVect.H>
#include <List.H>
 
// Our includes
#include <CD_NamespaceHeader.H>
 
template <class P>
class KDNode
{
public:
  using ParticleList = std::vector<P>;
 
  KDNode(const KDNode&) = delete;
 
  KDNode(const KDNode&&) = delete;
 
  KDNode&
  operator=(const KDNode&) = delete;
 
  KDNode&
  operator=(const KDNode&&) = delete;
 
  KDNode();
 
  KDNode(ParticleList& a_particles);
 
  virtual ~KDNode();
 
  inline const Real&
  weight() const noexcept;
 
  inline Real&
  weight() noexcept;
 
  inline const ParticleList&
  getParticles() const noexcept;
 
  inline ParticleList&
  getParticles() noexcept;
 
  inline bool
  isLeafNode() const noexcept;
 
  inline bool
  isInteriorNode() const noexcept;
 
  inline ParticleList
  gatherParticles() const noexcept;
 
  inline ParticleList
  moveParticles() noexcept;
 
  inline std::shared_ptr<KDNode<P>>&
  getLeft() noexcept;
 
  inline std::shared_ptr<KDNode<P>>&
  getRight() noexcept;
 
protected:
  std::shared_ptr<KDNode> m_left;
 
  std::shared_ptr<KDNode> m_right;
 
  Real m_weight;
 
  ParticleList m_particles;
 
  inline void
  gatherParticles(ParticleList& a_particles) const noexcept;
 
  inline void
  moveParticles(ParticleList& a_particles) noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_KDNodeImplem.H>
 
#endif