BiCGStabSmoother.H

Go to the documentation of this file.

/*   _______              __
    / ___/ /  ___  __ _  / /  ___
   / /__/ _ \/ _ \/  ' \/ _ \/ _ \
   \___/_//_/\___/_/_/_/_.__/\___/
*/
//
// This software is copyright (C) by the Lawrence Berkeley
// National Laboratory.  Permission is granted to reproduce
// this software for non-commercial purposes provided that
// this notice is left intact.
//
// It is acknowledged that the U.S. Government has rights to
// this software under Contract DE-AC03-765F00098 between
// the U.S.  Department of Energy and the University of
// California.
//
// This software is provided as a professional and academic
// contribution for joint exchange. Thus it is experimental,
// is provided ``as is'', with no warranties of any kind
// whatsoever, no support, no promise of updates, or printed
// documentation. By using this software, you acknowledge
// that the Lawrence Berkeley National Laboratory and
// Regents of the University of California shall have no
// liability with respect to the infringement of other
// copyrights by any part of this software.
//
// DFMartin, Sun, May 5, 2002

#ifndef _BICGSTABSMOOTHER_H_
#define _BICGSTABSMOOTHER_H_

#include <iostream>
#include <cmath>
#include <cassert>
#include <cstdlib>

#include "REAL.H"
#include "IntVect.H"
#include "Box.H"
#include "DisjointBoxLayout.H"
#include "LevelData.H"
#include "FArrayBox.H"
#include "ProblemDomain.H"

#include "BaseBottomSmoother.H"


class BiCGStabSmoother: public BaseBottomSmoother
{
public:
  BiCGStabSmoother();

  virtual ~BiCGStabSmoother();


  virtual BaseBottomSmoother* new_bottomSmoother() const;

  void setMaxIter(int a_maxIter);


  void setSolverTol(Real a_solverTol);


  void setEnableRestart(bool a_enableRestart);


  void setVerbose(bool a_verbose);


  virtual void doBottomSmooth(LevelData<FArrayBox>&       a_phi,
                              const LevelData<FArrayBox>& a_rhs,
                              LevelOp*                    a_levelopPtr);

  virtual void setConvergenceMetric(Real a_metric, int a_comp);

protected:
  int m_maxIter;

  Vector<Real> m_convergenceMetrics;

  Real m_solverTol;

  Real m_small;

  Real m_convergeSmall;

  bool m_enableRestart;

  bool m_verbose;
};

#endif

---