concepts::CGFabric< F > Class Template Reference

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

#include <cgFabric.hh>

Inheritance diagram for concepts::CGFabric< F >:

Collaboration diagram for concepts::CGFabric< F >:

List of all members.

Public Member Functions
	CGFabric (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)
	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>
class concepts::CGFabric< F >

Fabric class for conjugate gradients: CG.

Author:

Philipp Frauenfelder, 2002

Definition at line 24 of file cgFabric.hh.

---

Constructor & Destructor Documentation

template<typename F >

concepts::CGFabric< F >::CGFabric	(	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
throwing	In the case of non convergence an exception is thrown and the best solution is not given back.

Definition at line 33 of file cgFabric.hh.

---

Member Function Documentation

template<typename F >

virtual std::ostream& concepts::CGFabric< F >::info

(

std::ostream &

os

)

const [inline, protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 40 of file cgFabric.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 >

virtual Operator<F>* concepts::CGFabric< F >::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 cgFabric.hh.

Here is the call graph for this function:

---

Member Data Documentation

template<typename F >

Real concepts::CGFabric< F >::maxeps_ [private]

Convergence criteria for the solver.

Definition at line 46 of file cgFabric.hh.

template<typename F >

int concepts::CGFabric< F >::maxit_ [private]

Convergence criteria for the solver.

Definition at line 48 of file cgFabric.hh.

template<typename F >

bool concepts::CGFabric< F >::relres_ [private]

Convergence criteria for the solver.

Definition at line 50 of file cgFabric.hh.

template<typename F >

bool concepts::CGFabric< F >::throwing_ [private]

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

Definition at line 54 of file cgFabric.hh.

---

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

• operator/cgFabric.hh