CD_CdrMultigrid.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_CDRMULTIGRID_H
#define CD_CDRMULTIGRID_H
 
// Std includes
#include <random>
#include <time.h>
#include <chrono>
 
// Chombo includes
#include <AMRMultiGrid.H>
#include <BiCGStabSolver.H>
#include <EBSimpleSolver.H>
#include <GMRESSolver.H>
 
// Our includes
#include <CD_EBHelmholtzOpFactory.H>
#include <CD_CdrSolver.H>
#include <CD_EllipticSolverChain.H>
#include <CD_NamespaceHeader.H>
 
class CdrMultigrid : public CdrSolver
{
protected:
  enum class BottomSolverType
  {
    Simple,
    BiCGStab,
    GMRES
  };
 
  enum class MultigridType
  {
    VCycle,
    WCycle,
  };
 
public:
  CdrMultigrid();
 
  virtual ~CdrMultigrid();
 
  virtual void
  parseOptions() override = 0;
 
  virtual void
  parseRuntimeOptions() override = 0;
 
  virtual void
  registerOperators() override;
 
  virtual void
  allocate() override;
 
  virtual void
  preRegrid(const int a_lbase, const int a_oldFinestLevel) override;
 
  virtual void
  computeDivJ(EBAMRCellData& a_divJ,
              EBAMRCellData& a_phi,
              const Real     a_extrapDt,
              const bool     a_conservativeOnly,
              const bool     a_ebFlux,
              const bool     a_domainFlux) override final;
 
  virtual void
  computeDivF(EBAMRCellData& a_divF,
              EBAMRCellData& a_phi,
              const Real     a_extrapDt,
              const bool     a_conservativeOnly,
              const bool     a_ebFlux,
              const bool     a_domainFlux) override final;
 
  virtual void
  computeDivD(EBAMRCellData& a_divD,
              EBAMRCellData& a_phi,
              const bool     a_conservativeOnly,
              const bool     a_ebFlux,
              const bool     a_domainFlux) override final;
 
  virtual void
  advanceEuler(EBAMRCellData&       a_newPhi,
               const EBAMRCellData& a_oldPhi,
               const EBAMRCellData& a_source,
               const Real           a_dt) override final;
 
  virtual void
  advanceCrankNicholson(EBAMRCellData&       a_newPhi,
                        const EBAMRCellData& a_oldPhi,
                        const EBAMRCellData& a_source,
                        const Real           a_dt) override final;
 
protected:
  EBHelmholtzOp::Smoother m_smoother;
 
  int m_chebyOrder;
 
  Real m_chebyEigRatio;
 
  int m_rasInnerSweeps;
 
  MultigridType m_multigridType;
 
  RefCountedPtr<AMRMultiGrid<LevelData<EBCellFAB>>> m_multigridSolver;
 
  RefCountedPtr<EBHelmholtzOpFactory> m_helmholtzOpFactory;
 
  BiCGStabSolver<LevelData<EBCellFAB>> m_bicgstab;
 
  EBSimpleSolver m_simpleSolver;
 
  GMRESSolver<LevelData<EBCellFAB>> m_gmres;
 
  EllipticSolverChain::Settings m_krylovSettings;
 
  EllipticSolverChain::FallbackPolicy m_fallbackPolicy;
 
  EllipticSolverChain::KrylovSolver<EBCellFAB> m_krylov;
 
  bool m_hasMultigridSolver;
 
  bool m_multigridRefluxFree;
 
  EBAMRCellData m_helmAcoef;
 
  EBAMRCellData m_residual;
 
  int m_multigridVerbosity;
 
  int m_multigridPreSmooth;
 
  int m_multigridPostSmooth;
 
  int m_multigridBottomSmooth;
 
  int m_multigridMaxIterations;
 
  int m_multigridMinIterations;
 
  BottomSolverType m_bottomSolverType;
 
  int m_numSmoothingsForSimpleSolver;
 
  int m_minCellsBottom;
 
  Real m_multigridExitTolerance;
 
  Real m_multigridExitHang;
 
  virtual void
  advectToFaces(EBAMRFluxData& a_facePhi, const EBAMRCellData& a_phi, const Real a_extrapDt) override = 0;
 
  virtual void
  setupDiffusionSolver();
 
  virtual void
  setupHelmholtzFactory();
 
  virtual void
  setupMultigrid();
 
  virtual void
  setMultigridSolverCoefficients();
 
  virtual void
  resetAlphaAndBeta(const Real a_alpha, const Real a_beta);
 
  virtual void
  computeKappaLphi(EBAMRCellData& a_kappaLphi, const EBAMRCellData& a_phi);
 
  virtual void
  parseMultigridSettings();
};
 
#include <CD_NamespaceFooter.H>
 
#endif