---

GenBiCGStabSmoother.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 _GENBICGSTABSMOOTHER_H_
#define _GENBICGSTABSMOOTHER_H_

#include <iostream>
#include <math.h>
#include <assert.h>
#include <stdlib.h>

#include "REAL.H"

#include "GenSolverOp.H"
#include "GenBaseBottomSmoother.H"


template <class T> class GenBiCGStabSmoother : public GenBaseBottomSmoother<T>
{
public:
  GenBiCGStabSmoother();

  virtual ~GenBiCGStabSmoother();


  virtual GenBiCGStabSmoother<T>* newBottomSmoother() const;


  void setMaxIter(int a_maxIter);


  void setSolverTol(Real a_solverTol);


  void setEnableRestart(bool a_enableRestart);


  void setVerbose(bool a_verbose);


  virtual void doBottomSmooth(T&              a_phi,
                              const T&        a_rhs,
                              GenSolverOp<T>* a_operatorPtr);

protected:
  int m_maxIter;

  Real m_solverTol;

  // small parameter to check for division by zero
  Real m_small;

  // small parameter to check for size of correction (to prevent hanging)
  Real m_convergeSmall;

  // if true, enable restarting capability
  bool m_enableRestart;

  // default is false
  bool m_verbose;
};

#include "GenBiCGStabSmootherImplem.H"

#endif

---