CD_AMRMultigridKrylovOp.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_AMRMULTIGRIDKRYLOVOP_H
#define CD_AMRMULTIGRIDKRYLOVOP_H
 
// Std includes
#include <cmath>
 
// Chombo includes
#include <LinearSolver.H>
#include <AMRMultiGrid.H>
#include <LevelData.H>
#include <BaseFab.H>
#include <RefCountedPtr.H>
#include <Vector.H>
#include <EBCellFAB.H>
#include <MFCellFAB.H>
 
// Our includes
#include <CD_EBHelmholtzOp.H>
#include <CD_MFHelmholtzOp.H>
#include <CD_NamespaceHeader.H>
 
template <class T>
struct AMRMultigridKrylovOpTraits;
 
template <>
struct AMRMultigridKrylovOpTraits<EBCellFAB>
{
  using OpType = EBHelmholtzOp;
};
 
template <>
struct AMRMultigridKrylovOpTraits<MFCellFAB>
{
  using OpType = MFHelmholtzOp;
};
 
template <class T>
class AMRMultigridKrylovOp : public LinearOp<Vector<LevelData<T>*>>
{
public:
  AMRMultigridKrylovOp() = default;
 
  virtual ~AMRMultigridKrylovOp();
 
  void
  define(AMRMultiGrid<LevelData<T>>*                            a_mg,
         const Vector<RefCountedPtr<LevelData<BaseFab<bool>>>>& a_validCells,
         const Vector<Real>&                                    a_dx,
         const int                                              a_lbase,
         const int                                              a_lmax,
         const int                                              a_numVCycles);
 
  void
  applyOp(Vector<LevelData<T>*>& a_lhs, const Vector<LevelData<T>*>& a_phi, bool a_homogeneous = false) override;
 
  void
  residual(Vector<LevelData<T>*>&       a_lhs,
           const Vector<LevelData<T>*>& a_phi,
           const Vector<LevelData<T>*>& a_rhs,
           bool                         a_homogeneous = false) override;
 
  void
  preCond(Vector<LevelData<T>*>& a_cor, const Vector<LevelData<T>*>& a_residual) override;
 
  void
  create(Vector<LevelData<T>*>& a_lhs, const Vector<LevelData<T>*>& a_rhs) override;
 
  void
  clear(Vector<LevelData<T>*>& a_lhs) override;
 
  void
  assign(Vector<LevelData<T>*>& a_lhs, const Vector<LevelData<T>*>& a_rhs) override;
 
  Real
  dotProduct(const Vector<LevelData<T>*>& a_1, const Vector<LevelData<T>*>& a_2) override;
 
  void
  mDotProduct(const Vector<LevelData<T>*>& a_1,
              const int                    a_sz,
              const Vector<LevelData<T>*>  a_2[],
              Real                         a_mdots[]) override;
 
  void
  incr(Vector<LevelData<T>*>& a_lhs, const Vector<LevelData<T>*>& a_x, Real a_scale) override;
 
  void
  axby(Vector<LevelData<T>*>&       a_lhs,
       const Vector<LevelData<T>*>& a_x,
       const Vector<LevelData<T>*>& a_y,
       Real                         a_a,
       Real                         a_b) override;
 
  void
  scale(Vector<LevelData<T>*>& a_lhs, const Real& a_scale) override;
 
  Real
  norm(const Vector<LevelData<T>*>& a_rhs, int a_ord) override;
 
  void
  setToZero(Vector<LevelData<T>*>& a_lhs) override;
 
protected:
  AMRMultiGrid<LevelData<T>>* m_mg = nullptr;
 
  Vector<AMRLevelOp<LevelData<T>>*> m_amrOps;
 
  Vector<Real> m_dxScale;
 
  Vector<RefCountedPtr<LevelData<BaseFab<bool>>>> m_validMask;
 
  mutable Vector<Real> m_volume;
 
  mutable bool m_volumeCached = false;
 
  int m_lbase = 0;
 
  int m_lmax = 0;
 
  int m_numVCycles = 1;
 
  bool m_precondInit = false;
 
  mutable Vector<LevelData<T>*> m_precondTmp;
 
  mutable Vector<LevelData<T>*> m_precondDcor;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_AMRMultigridKrylovOpImplem.H>
 
#endif