CD_ParticleOps.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_PARTICLEOPS_H
#define CD_PARTICLEOPS_H
 
// Chombo includes
#include <RefCountedPtr.H>
#include <BaseIF.H>
#include <RealVect.H>
 
// Our includes
#include <CD_EBAMRData.H>
#include <CD_ParticleMap.H>
#include <CD_NamespaceHeader.H>
 
template <typename P>
class ParticleContainer;
 
class ParticleOps
{
public:
  static inline IntVect
  getParticleCellIndex(const RealVect& a_particlePosition, const RealVect& a_probLo, const Real& a_dx) noexcept;
 
  static inline IntVect
  getParticleCellIndex(const RealVect& a_particlePosition, const RealVect& a_probLo, const RealVect& a_dx) noexcept;
 
  template <typename P, const Real& (P::*weight)() const>
  static inline void
  getPhysicalParticlesPerCell(EBAMRCellData& a_ppc, const ParticleContainer<P>& a_src) noexcept;
 
  template <typename P>
  static inline void
  getComputationalParticlesPerCell(EBAMRCellData& a_ppc, const ParticleContainer<P>& a_src) noexcept;
 
  static inline IntVect
  getParticleGridCell(const RealVect& a_particlePosition, const RealVect& a_probLo, const RealVect& a_dx) noexcept;
 
  static inline bool
  domainIntersection(const RealVect& a_oldPos,
                     const RealVect& a_newPos,
                     const RealVect& a_probLo,
                     const RealVect& a_probHi,
                     Real&           a_s);
 
  static inline bool
  ebIntersectionBisect(const RefCountedPtr<BaseIF>& a_impFunc,
                       const RealVect&              a_oldPos,
                       const RealVect&              a_newPos,
                       const Real&                  a_bisectStep,
                       Real&                        a_s);
 
  static inline bool
  ebIntersectionRaycast(const RefCountedPtr<BaseIF>& a_impFunc,
                        const RealVect&              a_oldPos,
                        const RealVect&              a_newPos,
                        const Real&                  a_tolerance,
                        Real&                        a_s);
 
  template <typename P>
  static inline void
  copy(ParticleContainer<P>& a_dst, const ParticleContainer<P>& a_src) noexcept;
 
  template <typename P>
  static inline void
  copyDestructive(ParticleContainer<P>& a_dst, ParticleContainer<P>& a_src) noexcept;
 
  template <typename P, const Real& (P::*scalarQuantity)() const>
  static inline Real
  sum(const ParticleContainer<P>& a_particles) noexcept;
 
  template <typename P, Real (P::*scalarQuantity)()>
  static inline Real
  sum(const ParticleContainer<P>& a_particles) noexcept;
 
  template <typename P>
  static inline void
  removeParticles(ParticleContainer<P>& a_particles, const std::function<bool(const P&)>& a_removeCriterion) noexcept;
 
  template <typename P>
  static inline void
  transferParticles(ParticleContainer<P>&                a_dstParticles,
                    ParticleContainer<P>&                a_srcParticles,
                    const std::function<bool(const P&)>& a_transferCrit) noexcept;
 
  template <typename P>
  static inline void
  setData(ParticleContainer<P>& a_particles, const std::function<void(P&)>& a_functor) noexcept;
 
  template <typename P, Real& (P::*particleScalarField)()>
  static inline void
  setValue(ParticleContainer<P>& a_particles, const Real a_value) noexcept;
 
  template <typename P, RealVect& (P::*particleVectorField)()>
  static inline void
  setValue(ParticleContainer<P>& a_particles, const RealVect& a_value) noexcept;
 
#ifdef CH_MPI
  template <typename P>
  static inline void
  scatterParticles(ParticleMap<List<P>>&              a_receivedParticles,
                   std::vector<ParticleMap<List<P>>>& a_sentParticles) noexcept;
 
#endif
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ParticleOpsImplem.H>
 
#endif