CD_ParticleGhostMask.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_PARTICLEGHOSTMASK_H
#define CD_PARTICLEGHOSTMASK_H
 
// Std includes
#include <vector>
 
// Chombo includes
#include <CH_assert.H>
#include <Box.H>
#include <BaseFab.H>
#include <BoxIterator.H>
#include <LayoutData.H>
#include <RefCountedPtr.H>
#include <Vector.H>
 
// Our includes
#include <CD_LevelTiles.H>
#include <CD_NamespaceHeader.H>
 
class ParticleGhostMask
{
public:
  ParticleGhostMask() = default;
 
  ~ParticleGhostMask() = default;
 
  inline void
  define(const Box& a_box) noexcept;
 
  inline void
  incrementCount(const IntVect& a_iv) noexcept;
 
  inline void
  allocate() noexcept;
 
  inline void
  allocateTargetBoxes() noexcept;
 
  inline void
  addTarget(const IntVect& a_iv, const LevelTiles::BoxIDs& a_target) noexcept;
 
  inline void
  addTarget(const IntVect& a_iv, const LevelTiles::BoxIDs& a_target, const Box& a_targetBox) noexcept;
 
  inline void
  finalize() noexcept;
 
  inline const Box&
  box() const noexcept;
 
  inline int
  numTargets(const IntVect& a_iv) const noexcept;
 
  inline const LevelTiles::BoxIDs&
  target(const IntVect& a_iv, const int a_i) const noexcept;
 
  inline unsigned int
  targetGridIndex(const IntVect& a_iv, const int a_i) const noexcept;
 
  inline unsigned int
  targetRank(const IntVect& a_iv, const int a_i) const noexcept;
 
  inline const Box&
  targetBox(const IntVect& a_iv, const int a_i) const noexcept;
 
  inline bool
  hasTargetBoxes() const noexcept;
 
protected:
  Box m_box;
 
  BaseFab<int> m_start;
 
  BaseFab<int> m_count;
 
  std::vector<LevelTiles::BoxIDs> m_flat;
 
  std::vector<Box> m_flatBox;
};
 
using AMRParticleGhostMask = Vector<RefCountedPtr<LayoutData<ParticleGhostMask>>>;
 
#include <CD_NamespaceFooter.H>
 
#include <CD_ParticleGhostMaskImplem.H>
 
#endif