concepts::BiCGStabFabric< F, G > Class Template Reference

Fabric class for conjugate gradients: BiCGStab. More...

#include <bicgstabFabric.hh>

Inheritance diagram for concepts::BiCGStabFabric< F, G >:

Collaboration diagram for concepts::BiCGStabFabric< F, G >:

List of all members.

Public Member Functions
	BiCGStabFabric (Real maxeps=EPS, int maxit=0, bool relres=false, bool throwing=true)
	Constructor.
virtual Operator< F > *	operator() (SparseMatrix< F > &matrix)
virtual Operator< F > *	operator() (Operator< F > &matrix, Operator< G > &precond)
	Creates a linear solver from matrix and precond.
virtual Operator< F > *	operator() (Operator< F > &matrix)
	Creates a linear solver from matrix.
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Private Attributes
Real	maxeps_
	Convergence criteria for the solver.
int	maxit_
	Convergence criteria for the solver.
bool	relres_
	Convergence criteria for the solver.
bool	throwing_
	false: best solution is given, when non converging true: exception is thrown, when non converging

---

Detailed Description

template<typename F, typename G = F>
class concepts::BiCGStabFabric< F, G >

Fabric class for conjugate gradients: BiCGStab.

Author:

Philipp Frauenfelder, 2002

Definition at line 24 of file bicgstabFabric.hh.

---

Constructor & Destructor Documentation

template<typename F , typename G = F>

concepts::BiCGStabFabric< F, G >::BiCGStabFabric	(	Real	maxeps = EPS,
		int	maxit = 0,
		bool	relres = false,
		bool	throwing = true
	)		[inline]

Constructor.

Parameters:

maxeps	Maximal residual
maxit	Maximal number of iterations
relres	Relative residual

Definition at line 32 of file bicgstabFabric.hh.

---

Member Function Documentation

template<typename F , typename G = F>

virtual std::ostream& concepts::BiCGStabFabric< F, G >::info

(

std::ostream &

os

)

const [inline, protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 45 of file bicgstabFabric.hh.

template<typename F>

virtual Operator<F>* concepts::SolverFabric< F >::operator()

(

SparseMatrix< F > &

matrix

)

[inline, virtual, inherited]

Definition at line 26 of file solverFabric.hh.

template<typename F , typename G = F>

virtual Operator<F>* concepts::BiCGStabFabric< F, G >::operator()

(

Operator< F > &

matrix

)

[inline, virtual]

Creates a linear solver from matrix.

The caller is responsible for the deletion of the delivered object.

Returns:

Reference to the linear solver

Implements concepts::SolverFabric< F >.

Definition at line 36 of file bicgstabFabric.hh.

Here is the call graph for this function:

template<typename F , typename G = F>

virtual Operator<F>* concepts::BiCGStabFabric< F, G >::operator()	(	Operator< F > &	matrix,
		Operator< G > &	precond
	)		[inline, virtual]

Creates a linear solver from matrix and precond.

The caller is responsible for the deletion of the delivered object.

Returns:

Reference to the linear solver

Implements concepts::PrecondSolverFabric< F, G >.

Definition at line 39 of file bicgstabFabric.hh.

Here is the call graph for this function:

---

Member Data Documentation

template<typename F , typename G = F>

Real concepts::BiCGStabFabric< F, G >::maxeps_ [private]

Convergence criteria for the solver.

Definition at line 51 of file bicgstabFabric.hh.

template<typename F , typename G = F>

int concepts::BiCGStabFabric< F, G >::maxit_ [private]

Convergence criteria for the solver.

Definition at line 53 of file bicgstabFabric.hh.

template<typename F , typename G = F>

bool concepts::BiCGStabFabric< F, G >::relres_ [private]

Convergence criteria for the solver.

Definition at line 55 of file bicgstabFabric.hh.

template<typename F , typename G = F>

bool concepts::BiCGStabFabric< F, G >::throwing_ [private]

false: best solution is given, when non converging true: exception is thrown, when non converging

Definition at line 59 of file bicgstabFabric.hh.

---

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

• operator/bicgstabFabric.hh