CD_EBParticleMesh.H

Go to the documentation of this file.

/* chombo-discharge
 * Copyright © 2021 SINTEF Energy Research.
 * Please refer to Copyright.txt and LICENSE in the chombo-discharge root directory.
 */
 
#ifndef CD_EBParticleMesh_H
#define CD_EBParticleMesh_H
 
// Std includes
#include <type_traits>
 
// Chombo includes
#include <EBISBox.H>
#include <EBCellFAB.H>
#include <Vector.H>
#include <RealVect.H>
 
// Our includes
#include <CD_DepositionType.H>
#include <CD_NamespaceHeader.H>
 
class EBParticleMesh
{
public:
  EBParticleMesh();
 
  EBParticleMesh(const ProblemDomain& a_domain,
                 const Box&           a_region,
                 const EBISBox&       a_ebisbox,
                 const RealVect&      a_dx,
                 const RealVect&      a_probLo);
 
  void
  define(const ProblemDomain& a_domain,
         const Box&           a_region,
         const EBISBox&       a_ebisbox,
         const RealVect&      a_dx,
         const RealVect&      a_probLo);
 
  template <class P, class Ret, Ret (P::*MemberFunc)() const>
  void
  deposit(EBCellFAB&           a_meshData,
          const List<P>&       a_particles,
          const DepositionType a_depositionType,
          const Real           a_widthScale,
          const bool           a_forceIrregNGP = false) const;
 
  template <class P, class Ret, Ret (P::*MemberFunc)()>
  void
  interpolate(List<P>&             a_particles,
              const EBCellFAB&     a_meshData,
              const DepositionType a_interpType,
              const bool           a_forceIrregNGP = false) const;
 
  template <typename Ret>
  static inline constexpr int
  sanitize() noexcept
  {
    using NoRef = typename std::remove_reference<Ret>::type;
    using Base  = typename std::remove_cv<NoRef>::type;
 
    static_assert(std::is_same<Base, Real>::value || std::is_same<Base, RealVect>::value,
                  "Ret should be Real or RealVect");
 
    return std::is_same<Base, Real>::value ? 1 : SpaceDim;
  }
 
protected:
  ProblemDomain m_domain;
 
  bool m_verbose;
 
  Box m_region;
 
  EBISBox m_ebisbox;
 
  RealVect m_dx;
 
  RealVect m_probLo;
 
  inline void
  depositParticleNGP(EBCellFAB&      a_rho,
                     const RealVect& a_position,
                     const Real&     a_volumeFactor,
                     const Real*     a_strength,
                     const int&      a_numComp) const noexcept;
 
  inline void
  depositParticleCIC(EBCellFAB&      a_rho,
                     const RealVect& a_position,
                     const RealVect& a_particleWidth,
                     const Box&      a_particleBox,
                     const Real&     a_volumeFactor,
                     const Real*     a_strength,
                     const int&      a_numComp,
                     const bool      a_forceIrregNGP) const noexcept;
 
  inline void
  depositParticleTSC(EBCellFAB&      a_rho,
                     const RealVect& a_position,
                     const RealVect& a_particleWidth,
                     const Box&      a_particleBox,
                     const Real&     a_volumeFactor,
                     const Real*     a_strength,
                     const int&      a_numComp,
                     const bool      a_forceIrregNGP) const noexcept;
 
  inline void
  interpolateParticleNGP(Real*            a_particleField,
                         const EBCellFAB& a_meshData,
                         const RealVect&  a_position,
                         const int&       a_numComp) const noexcept;
 
  inline void
  interpolateParticleCIC(Real*            a_particleField,
                         const EBCellFAB& a_meshData,
                         const Box&       a_validBox,
                         const Box&       a_gatherBox,
                         const RealVect&  a_position,
                         const int&       a_numComp,
                         const bool       a_forceIrregNGP) const noexcept;
 
  inline void
  interpolateParticleTSC(Real*            a_particleField,
                         const EBCellFAB& a_meshData,
                         const Box&       a_validBox,
                         const Box&       a_gatherBox,
                         const RealVect&  a_position,
                         const int&       a_numComp,
                         const bool       a_forceIrregNGP) const noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_EBParticleMeshImplem.H>
 
#endif