cheby.h File Reference

Iterative Vector equation solver TBCI::CHEBY. More...

#include "tbci/basics.h"
#include "tbci/solver/precond.h"

Include dependency graph for cheby.h:

Go to the source code of this file.

Macros
#define	VALUE_TYPE   typename SysVector::value_type

Functions
NAMESPACE_TBCI	INST3 (template< typename T, Matrix< T >, Vector< T > > class NN friend int CHEBY(const Matrix< T > &, Vector< T > &, const Vector< T > &, const Preconditioner_Sig< T, Matrix< T > > &, unsigned int &, double &, T, T);) INST3(template< typename T
NAMESPACE_TBCI Vector< T > class NN friend int	CHEBY (const BdMatrix< T > &, Vector< T > &, const Vector< T > &, const Preconditioner_Sig< T, BdMatrix< T > > &, unsigned int &, double &, T, T)
template<typename T, typename SysMatrix, typename SysVector>
int	CHEBY (const SysMatrix &A, SysVector &x, const SysVector &b, const Preconditioner_Sig< T, SysMatrix > &M, unsigned int &max_iter, double &tol, T eigmin, T eigmax)
	Iterative template routine – CHEBY.

Variables
NAMESPACE_TBCI	BdMatrix< T >

Detailed Description

Iterative Vector equation solver TBCI::CHEBY.

Definition in file cheby.h.

Macro Definition Documentation

VALUE_TYPE

#define VALUE_TYPE   typename SysVector::value_type

Definition at line 32 of file cheby.h.

Referenced by CHEBY().

Function Documentation

CHEBY() [1/2]

NAMESPACE_TBCI Vector< T > class NN friend int CHEBY	(	const BdMatrix< T > &	,
		Vector< T > &	,
		const Vector< T > &	,
		const Preconditioner_Sig< T, BdMatrix< T > > &	,
		unsigned int &	,
		double &	,
		T	,
		T	)

References CHEBY(), and T.

Referenced by CHEBY(), and CHEBY().

CHEBY() [2/2]

template<typename T, typename SysMatrix, typename SysVector>

int CHEBY	(	const SysMatrix &	A,
		SysVector &	x,
		const SysVector &	b,
		const Preconditioner_Sig< T, SysMatrix > &	M,
		unsigned int &	max_iter,
		double &	tol,
		T	eigmin,
		T	eigmax )

Iterative template routine – CHEBY.

CHEBY solves the symmetric positive definite linear system Ax = b using the Preconditioned Chebyshev Method

CHEBY follows the algorithm described on p. 30 of the SIAM Templates book.

Returns

The return value indicates convergence within max_iter (input) iterations (0), or no convergence within max_iter iterations (1).

Upon successful return, output arguments have the following values:

Parameters

x	– approximate solution to Ax = b
max_iter	– the number of iterations performed before the tolerance was reached
tol	– the residual after the final iteration

Definition at line 60 of file cheby.h.

References b, c, CHEBY(), i, p, Preconditioner_Sig< T, MatrixType >::solve(), SysMatrix, T, VALUE_TYPE, and x.

INST3()

NAMESPACE_TBCI INST3

(

template< typename T, Matrix< T >, Vector< T > > class NN friend int CHEBY(const Matrix< T > &, Vector< T > &, const Vector< T > &, const Preconditioner_Sig< T, Matrix< T > > &, unsigned int &, double &, T, T);

)

Variable Documentation

BdMatrix< T >

NAMESPACE_TBCI BdMatrix< T >

Definition at line 15 of file cheby.h.