concepts::GMResFabric< F > Class Template Referenceabstract

Fabric class for generalized minimal residual: GMRes. More...

#include <gmresFabric.hh>

Inheritance diagram for concepts::GMResFabric< F >:

Public Member Functions
	GMResFabric (Real maxeps=EPS, int maxit=0, uint rs=0, uint relres=0)
	Constructor. More...
virtual Operator< F > *	operator() ()=0
	Creates a linear solver from matrix. More...
virtual Operator< F > *	operator() (Operator< F > &matrix)

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const

Private Attributes
Real	maxeps_
	Convergence criteria for the solver. More...
int	maxit_
	Convergence criteria for the solver. More...
uint	relres_
	relres = 0: absolute residual, relres = 1: relative residual More...
uint	rs_
	Restart. More...

Detailed Description

template<typename F>
class concepts::GMResFabric< F >

Fabric class for generalized minimal residual: GMRes.

Author

Christoph Winkelmann, 2004

Definition at line 27 of file gmresFabric.hh.

Constructor & Destructor Documentation

GMResFabric()

template<typename F >

concepts::GMResFabric< F >::GMResFabric ( Real  maxeps = EPS, int  maxit = 0, uint  rs = 0, uint  relres = 0  )

inline

Constructor.

Parameters

maxeps	Maximal residual
maxit	Maximal number of iterations
rs	Restart
relres	0: absolute residual, 1: relative residual

Definition at line 35 of file gmresFabric.hh.

Member Function Documentation

info()

template<typename F >

virtual std::ostream& concepts::GMResFabric< F >::info ( std::ostream &  os ) const

inlineprotectedvirtual

Definition at line 42 of file gmresFabric.hh.

operator()() [1/2]

template<typename F >

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

pure virtualinherited

Creates a linear solver from matrix.

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

Returns

Reference to the linear solver

Implemented in concepts::UmfpackFabric, concepts::SuperLUFabric< F >, concepts::MumpsOverlapFabric< F >, concepts::MumpsFabric< F >, concepts::CGFabric< F >, and concepts::BiCGStabFabric< F, G >.

operator()() [2/2]

template<typename F >

virtual Operator<F>* concepts::GMResFabric< F >::operator() ( Operator< F > &  matrix )

inlinevirtual

Implements concepts::SolverFabric< F >.

Definition at line 38 of file gmresFabric.hh.

Member Data Documentation

maxeps_

template<typename F >

Real concepts::GMResFabric< F >::maxeps_

private

Convergence criteria for the solver.

Definition at line 49 of file gmresFabric.hh.

maxit_

template<typename F >

int concepts::GMResFabric< F >::maxit_

private

Convergence criteria for the solver.

Definition at line 51 of file gmresFabric.hh.

relres_

template<typename F >

uint concepts::GMResFabric< F >::relres_

private

relres = 0: absolute residual, relres = 1: relative residual

Definition at line 55 of file gmresFabric.hh.

rs_

template<typename F >

uint concepts::GMResFabric< F >::rs_

private

Restart.

Definition at line 53 of file gmresFabric.hh.

---

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

• operator/gmresFabric.hh