CD_MFHelmholtzJumpBC.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_MFHELMHOLTZJUMPBC_H
#define CD_MFHELMHOLTZJUMPBC_H
 
// Chombo includes
#include <MFCellFAB.H>
#include <EBISBox.H>
#include <LayoutData.H>
#include <Stencils.H>
#include <AggStencil.H>
#include <EBCellFAB.H>
#include <BaseIVFAB.H>
 
// Our includes
#include <CD_Location.H>
#include <CD_MFLevelGrid.H>
#include <CD_VofUtils.H>
#include <CD_MFInterfaceFAB.H>
#include <CD_MFBaseIVFAB.H>
#include <CD_NamespaceHeader.H>
 
class MFHelmholtzJumpBC
{
public:
  using BcoefPtr = RefCountedPtr<LevelData<MFBaseIVFAB>>;
 
  using AmrMask = RefCountedPtr<LevelData<BaseFab<bool>>>;
 
  MFHelmholtzJumpBC() = delete;
 
  MFHelmholtzJumpBC(Location::Cell     a_dataLocation,
                    const MFLevelGrid& a_mflg,
                    const BcoefPtr&    a_Bcoef,
                    const AmrMask&     a_validCells,
                    Real               a_dx,
                    int                a_order,
                    int                a_weight,
                    int                a_radius,
                    int                a_ghostCF,
                    IntVect            a_ghostPhi);
 
  MFHelmholtzJumpBC(const MFHelmholtzJumpBC& a_other) = delete;
 
  virtual ~MFHelmholtzJumpBC();
 
  MFHelmholtzJumpBC&
  operator=(const MFHelmholtzJumpBC& a_other) = delete;
 
  MFHelmholtzJumpBC(MFHelmholtzJumpBC&&) = delete;
  MFHelmholtzJumpBC&
  operator=(MFHelmholtzJumpBC&&) = delete;
 
  void
  setBco(const RefCountedPtr<LevelData<MFBaseIVFAB>>& a_Bcoef);
 
  bool
  isMultiPhase() const noexcept;
 
  int
  getOrder() const;
 
  int
  getWeight() const;
 
  int
  getRadius() const;
 
  void
  setCoarseGridDropOrder(bool a_dropOrder);
 
  virtual void
  matchBC(LevelData<BaseIVFAB<Real>>& a_jump, const LevelData<MFCellFAB>& a_phi, bool a_homogeneousPhysBC) const;
 
  virtual void
  matchBC(BaseIVFAB<Real>& a_jump, const MFCellFAB& a_phi, bool a_homogeneousPhysBC, const DataIndex& a_dit) const;
 
  virtual const BaseIVFAB<Real>&
  getBndryPhi(int a_phase, const DataIndex& a_dit) const;
 
  virtual VoFIterator&
  getSinglePhaseVofs(int a_phase, const DataIndex& a_dit) const;
 
  virtual VoFIterator&
  getMultiPhaseVofs(int a_phase, const DataIndex& a_dit) const;
 
  virtual const LayoutData<MFInterfaceFAB<VoFStencil>>&
  getGradPhiStencils() const noexcept;
 
  virtual const LayoutData<MFInterfaceFAB<Real>>&
  getGradPhiWeights() const noexcept;
 
  virtual void
  resetBC() const;
 
protected:
  static constexpr int m_comp = 0;
 
  static constexpr int m_nComp = 1;
 
  Location::Cell m_dataLocation;
 
  MFLevelGrid m_mflg;
 
  RefCountedPtr<LevelData<MFBaseIVFAB>> m_Bcoef;
 
  RefCountedPtr<LevelData<BaseFab<bool>>> m_validCells;
 
  Real m_dx;
 
  int m_order;
 
  int m_weight;
 
  int m_radius;
 
  int m_ghostCF;
 
  int m_numPhases;
 
  IntVect m_ghostPhi;
 
  bool m_multiPhase;
 
  bool m_dropOrder;
 
  mutable LayoutData<MFInterfaceFAB<Real>> m_boundaryPhi;
 
  mutable std::map<int, std::shared_ptr<LayoutData<VoFIterator>>> m_singlePhaseVofs;
 
  mutable std::map<int, std::shared_ptr<LayoutData<VoFIterator>>> m_multiPhaseVofs;
 
  LayoutData<IntVectSet> m_ivs;
 
  LayoutData<MFInterfaceFAB<VoFStencil>> m_gradPhiStencils;
 
  LayoutData<MFInterfaceFAB<Real>> m_gradPhiWeights;
 
  LayoutData<MFInterfaceFAB<VoFStencil>> m_avgStencils;
 
  LayoutData<MFInterfaceFAB<Vector<VolIndex>>> m_avgVoFs;
 
  LayoutData<MFInterfaceFAB<Real>> m_denom;
 
  LayoutData<MFInterfaceFAB<Real>> m_avgWeights;
 
  LayoutData<RefCountedPtr<AggStencil<EBCellFAB, BaseIVFAB<Real>>>> m_aggStencils[2];
 
  void
  defineStencils();
 
  void
  defineIterators();
 
  void
  buildAverageStencils();
 
  virtual bool
  getLeastSquaresBoundaryGradStencil(std::pair<Real, VoFStencil>& a_stencil,
                                     const VolIndex&              a_vof,
                                     const EBISBox&               a_ebisbox,
                                     VofUtils::Neighborhood       a_neighborhood,
                                     int                          a_order) const;
 
  inline bool
  isStencilValidCF(const VoFStencil& a_stencil, const DataIndex& a_dit) const;
 
  inline Real
  applyStencil(const VoFStencil& a_stencil, const EBCellFAB& a_phi) const;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_MFHelmholtzJumpBCImplem.H>
 
#endif