RelaxSolver< T > Class Template Reference

#include <RelaxSolver.H>

Inheritance diagram for RelaxSolver< T >:

[legend]

List of all members.

---

Detailed Description

template<class T>
class RelaxSolver< T >

Iterative solver which only uses the operator's preconditioner. Probably only useful as a bottom solver.

Public Member Functions
	RelaxSolver ()
virtual	~RelaxSolver ()
virtual void	setHomogeneous (bool a_homogeneous)
virtual void	define (LinearOp< T > *a_op, bool a_homogeneous)
virtual void	solve (T &a_phi, const T &a_rhs)
Public Attributes
bool	m_homogeneous
LinearOp< T > *	m_op
int	m_imax
int	m_normType
int	m_verbosity
Real	m_eps
Real	m_hang
Private Attributes
Real	m_minNorm

---

Constructor & Destructor Documentation

template<class T>

RelaxSolver< T >::RelaxSolver

(

)

[inline]

template<class T>

RelaxSolver< T >::~RelaxSolver

(

)

[inline, virtual]

---

Member Function Documentation

template<class T>

virtual void RelaxSolver< T >::setHomogeneous

(

bool

a_homogeneous

)

[inline, virtual]

Set whether the solver uses only homogeneous boundary conditions

Implements LinearSolver< T >.

References RelaxSolver< T >::m_homogeneous.

template<class T>

void RelaxSolver< T >::define	(	LinearOp< T > *	a_op,
		bool	a_homogeneous
	)			[inline, virtual]

Define the solver. a_op is the linear operator.

Implements LinearSolver< T >.

References RelaxSolver< T >::m_homogeneous, and RelaxSolver< T >::m_op.

template<class T>

void RelaxSolver< T >::solve	(	T &	a_phi,
		const T &	a_rhs
	)			[inline, virtual]

Solve L(phi) = rho

Implements LinearSolver< T >.

References CH_assert, CH_TIME, RelaxSolver< T >::m_eps, RelaxSolver< T >::m_hang, RelaxSolver< T >::m_homogeneous, RelaxSolver< T >::m_imax, RelaxSolver< T >::m_minNorm, RelaxSolver< T >::m_normType, RelaxSolver< T >::m_op, RelaxSolver< T >::m_verbosity, norm(), and pout().

---

Member Data Documentation

template<class T>

bool RelaxSolver< T >::m_homogeneous

public member data: whether or not to use inhomogeneous boundary conditions.

Referenced by RelaxSolver< T >::define(), RelaxSolver< T >::setHomogeneous(), and RelaxSolver< T >::solve().

template<class T>

LinearOp<T>* RelaxSolver< T >::m_op

public member data: linear operator.

Referenced by RelaxSolver< T >::define(), and RelaxSolver< T >::solve().

template<class T>

int RelaxSolver< T >::m_imax

public member data: maximum number of iterations

Referenced by RelaxSolver< T >::solve().

template<class T>

int RelaxSolver< T >::m_normType

public member data: which type of norm to use (default is 2-norm)

Referenced by RelaxSolver< T >::solve().

template<class T>

int RelaxSolver< T >::m_verbosity

public member data: how much screen output user wants

Referenced by RelaxSolver< T >::solve().

template<class T>

Real RelaxSolver< T >::m_eps

public member data: solver tolerance

Referenced by RelaxSolver< T >::solve().

template<class T>

Real RelaxSolver< T >::m_hang

public member data: hang when min(previous residual norms) < m_hang * current residual norm (default is zero -- don't check for hanging)

Referenced by RelaxSolver< T >::solve().

template<class T>

Real RelaxSolver< T >::m_minNorm [private]

Referenced by RelaxSolver< T >::solve().

---

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

• RelaxSolver.H