---

GenBiCGStabSmoother< T > Class Template Reference

Implements BiCGStab as a bottom smoother for GenSolverOp-derived classes. More...

#include <GenBiCGStabSmoother.H>

Inheritance diagram for GenBiCGStabSmoother< T >:

[legend]Collaboration diagram for GenBiCGStabSmoother< T >:

[legend]List of all members.

Public Methods
	GenBiCGStabSmoother ()
	constructor
virtual	~GenBiCGStabSmoother ()
	destructor
virtual GenBiCGStabSmoother< T > *	newBottomSmoother () const
void	setMaxIter (int a_maxIter)
	set maximum number of BiCGStab iterations
void	setSolverTol (Real a_solverTol)
	set solver tolerance
void	setEnableRestart (bool a_enableRestart)
	set whether to enable restart capabillity
void	setVerbose (bool a_verbose)
	set verbosity level
virtual void	doBottomSmooth (T &a_phi, const T &a_rhs, GenSolverOp< T > *a_operatorPtr)
	do smoothing
Protected Attributes
int	m_maxIter
Real	m_solverTol
Real	m_small
Real	m_convergeSmall
bool	m_enableRestart
bool	m_verbose

---

Detailed Description

template<class T>
class GenBiCGStabSmoother< T >

Implements BiCGStab as a bottom smoother for GenSolverOp-derived classes.

The GenBiCGStabSmoother class implements the BiCGStab algorithm for GenSolverOp-derived classes

---

Constructor & Destructor Documentation

template<class T> GenBiCGStabSmoother< T >::GenBiCGStabSmoother (    )

constructor

template<class T> GenBiCGStabSmoother< T >::~GenBiCGStabSmoother (    )  [virtual]

destructor

---

Member Function Documentation

template<class T> void GenBiCGStabSmoother< T >::doBottomSmooth (  T &    a_phi, const T &    a_rhs, GenSolverOp< T > *    a_operatorPtr )  [virtual]

do smoothing performs BiCGStab smoothing of L(a_phi) = a_rhs; L is the operator defined in a_levelopPtr, and the preconditioner is a_levelopPtr->smooth Implements GenBaseBottomSmoother< T >.

template<class T> GenBiCGStabSmoother< T > * GenBiCGStabSmoother< T >::newBottomSmoother (    )  const [virtual]

this gets around the "no virtual constructor" rule Implements GenBaseBottomSmoother< T >.

template<class T> void GenBiCGStabSmoother< T >::setEnableRestart (  bool    a_enableRestart )

set whether to enable restart capabillity if this is true, if BiCGStab reaches a hang point, the solver will recompute the residual and attempt to restart the computation

template<class T> void GenBiCGStabSmoother< T >::setMaxIter (  int    a_maxIter )

set maximum number of BiCGStab iterations set max number of BiCGStab iterations

template<class T> void GenBiCGStabSmoother< T >::setSolverTol (  Real    a_solverTol )

set solver tolerance set solver tolerance (amount residual must be decreased, etc)

template<class T> void GenBiCGStabSmoother< T >::setVerbose (  bool    a_verbose )

set verbosity level set whether i/o is done when solving (default is false)

---

Member Data Documentation

template<class T> Real GenBiCGStabSmoother< T >::m_convergeSmall [protected]

template<class T> bool GenBiCGStabSmoother< T >::m_enableRestart [protected]

template<class T> int GenBiCGStabSmoother< T >::m_maxIter [protected]

template<class T> Real GenBiCGStabSmoother< T >::m_small [protected]

template<class T> Real GenBiCGStabSmoother< T >::m_solverTol [protected]

template<class T> bool GenBiCGStabSmoother< T >::m_verbose [protected]

---

The documentation for this class was generated from the following files:

• GenBiCGStabSmoother.H
• GenBiCGStabSmootherImplem.H

---