CD_EBGradient.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_EBGRADIENT_H
#define CD_EBGRADIENT_H
 
// Std includes
#include <array>
 
// Chombo includes
#include <EBLevelGrid.H>
#include <AggStencil.H>
#include <FaceIterator.H>
 
// Our includes
#include <CD_Location.H>
#include <CD_NamespaceHeader.H>
 
class EBGradient
{
public:
  using CellLocation = Location::Cell;
 
  EBGradient() = delete;
 
  EBGradient(const EBGradient& a_other) = delete;
 
  EBGradient(const EBLevelGrid& a_eblg,
             const EBLevelGrid& a_eblgFine,
             const EBLevelGrid& a_eblgFiCo,
             const bool         a_hasFine,
             const Real         a_dx,
             const int          a_refRat,
             const int          a_order,
             const int          a_weighting,
             const IntVect      a_ghostVector) noexcept;
 
  virtual ~EBGradient() noexcept;
 
  virtual void
  define(const EBLevelGrid& a_eblg,
         const EBLevelGrid& a_eblgFine,
         const EBLevelGrid& a_eblgFiCo,
         const bool         a_hasFine,
         const Real         a_dx,
         const int          a_refRat,
         const int          a_order,
         const int          a_weighting,
         const IntVect      a_ghostVector) noexcept;
 
  virtual void
  computeLevelGradient(LevelData<EBCellFAB>& a_gradient, const LevelData<EBCellFAB>& a_phi) const noexcept;
 
  virtual void
  computeNormalDerivative(LevelData<EBFluxFAB>& a_gradient, const LevelData<EBCellFAB>& a_phi) const noexcept;
 
  virtual void
  computeAMRGradient(LevelData<EBCellFAB>&       a_gradient,
                     const LevelData<EBCellFAB>& a_phi,
                     const LevelData<EBCellFAB>& a_phiFine) const noexcept;
 
protected:
  static constexpr int m_comp = 0;
 
  static constexpr int m_nComp = 1;
 
  CellLocation m_dataLocation;
 
  EBLevelGrid m_eblg;
 
  EBLevelGrid m_eblgFine;
 
  EBLevelGrid m_eblgFiCo;
 
  bool m_isDefined;
 
  bool m_hasFine;
 
  bool m_hasEBCF;
 
  Real m_dx;
 
  Real m_dxFine;
 
  int m_order;
 
  int m_weighting;
 
  int m_refRat;
 
  IntVect m_ghostVector;
 
  Copier m_copier;
 
  LayoutData<BaseIVFAB<VoFStencil>> m_levelStencils;
 
  LayoutData<BaseIVFAB<VoFStencil>> m_ebcfStencilsCoar;
 
  LayoutData<BaseIVFAB<VoFStencil>> m_ebcfStencilsFine;
 
  LayoutData<RefCountedPtr<AggStencil<EBCellFAB, EBCellFAB>>> m_aggLevelStencils[SpaceDim];
 
  mutable LayoutData<VoFIterator> m_levelIterator;
 
  mutable LayoutData<VoFIterator> m_ebcfIterator;
 
  mutable LayoutData<std::array<FaceIterator, SpaceDim>> m_multiCutFaceIter;
 
  virtual void
  defineLevelStencils() noexcept;
 
  virtual void
  defineMasks(LevelData<FArrayBox>& a_coarMaskCF, LevelData<FArrayBox>& a_coarMaskInvalid) noexcept;
 
  virtual void
  defineIteratorsEBCF(const LevelData<FArrayBox>& a_coarMaskCF, const LevelData<FArrayBox>& a_coarMaskInvalid) noexcept;
 
  virtual void
  defineStencilsEBCF(const LevelData<FArrayBox>& a_coarMaskInvalid) noexcept;
 
  virtual void
  defineBuffers() noexcept;
 
  virtual bool
  getFiniteDifferenceStencil(VoFStencil&            a_stencil,
                             const VolIndex&        a_vof,
                             const EBISBox&         a_ebisBox,
                             const DenseIntVectSet& a_validRegion,
                             const Real             a_dx) const noexcept;
 
  virtual bool
  getLeastSquaresStencil(VoFStencil&            a_stencilCoar,
                         VoFStencil&            a_stencilFine,
                         const VolIndex&        a_vofCoar,
                         const CellLocation&    a_dataLocation,
                         const EBISLayout&      a_ebislCoar,
                         const EBISLayout&      a_ebislFine,
                         const DataIndex&       a_dit,
                         const DenseIntVectSet& a_validCellsCoar,
                         const DenseIntVectSet& a_validCellsFine,
                         const Real&            a_dxCoar,
                         const Real&            a_dxFine,
                         const int&             a_order,
                         const int&             a_weight) const noexcept;
 
  virtual bool
  isFiniteDifferenceStencilValid(const IntVect&   a_ivCoar,
                                 const EBISBox&   a_ebisBox,
                                 const FArrayBox& a_invalidRegion) const noexcept;
 
  virtual void
  makeAggStencils() noexcept;
};
 
#include <CD_NamespaceFooter.H>
 
#endif