CD_KrylovBiCGStab.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_KRYLOVBICGSTAB_H
#define CD_KRYLOVBICGSTAB_H
 
// Chombo includes
#include <LevelData.H>
#include <Vector.H>
 
// Our includes
#include <CD_AMRMultigridKrylovOp.H>
#include <CD_NamespaceHeader.H>
 
template <class T>
class KrylovBiCGStab
{
public:
  Real m_eps = 1.E-10;
 
  int m_maxIter = 50;
 
  int m_numRestarts = 5;
 
  int m_verbosity = -1;
 
  int m_exitStatus = -1;
 
  Real m_residualNorm = -1.0;
 
  int m_iterations = 0;
 
  Real m_residualScale = 1.0;
 
  KrylovBiCGStab() noexcept = default;
 
  ~KrylovBiCGStab() noexcept;
 
  void
  define(AMRMultigridKrylovOp<T>* a_op, const Vector<LevelData<T>*>& a_template) noexcept;
 
  void
  undefine() noexcept;
 
  bool
  isDefined() const noexcept;
 
  bool
  solve(Vector<LevelData<T>*>& a_phi, const Vector<LevelData<T>*>& a_rhs) noexcept;
 
protected:
  AMRMultigridKrylovOp<T>* m_op = nullptr;
 
  bool m_isDefined = false;
 
  Vector<LevelData<T>*> m_r;
 
  Vector<LevelData<T>*> m_rTilde;
 
  Vector<LevelData<T>*> m_e;
 
  Vector<LevelData<T>*> m_p;
 
  Vector<LevelData<T>*> m_pTilde;
 
  Vector<LevelData<T>*> m_sTilde;
 
  Vector<LevelData<T>*> m_t;
 
  Vector<LevelData<T>*> m_v;
};
 
#include <CD_NamespaceFooter.H>
 
#include <CD_KrylovBiCGStabImplem.H>
 
#endif