Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::BiCGStabFabric< F, G > Class Template Reference

#include <bicgstabFabric.hh>

Inheritance diagram for concepts::BiCGStabFabric< F, G >:
concepts::PrecondSolverFabric< F, G > concepts::SolverFabric< F > concepts::OutputOperator

Public Member Functions

 BiCGStabFabric (Real maxeps=EPS, int maxit=0, bool relres=false, bool throwing=true)
 
virtual Operator< F > * operator() ()
 
virtual Operator< F > * operator() (Operator< F > &matrix)
 
virtual Operator< F > * operator() (Operator< F > &matrix, Operator< G > &precond)
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

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 27 of file bicgstabFabric.hh.

Constructor & Destructor Documentation

◆ BiCGStabFabric()

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
maxepsMaximal residual
maxitMaximal number of iterations
relresRelative residual

Definition at line 35 of file bicgstabFabric.hh.

Member Function Documentation

◆ info()

template<typename F , typename G = F>
virtual std::ostream & concepts::BiCGStabFabric< F, G >::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 51 of file bicgstabFabric.hh.

◆ operator()() [1/3]

template<typename F , typename G = F>
virtual Operator< F > * concepts::BiCGStabFabric< F, G >::operator() ( )
inlinevirtual

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 39 of file bicgstabFabric.hh.

◆ operator()() [2/3]

template<typename F , typename G = F>
virtual Operator< F > * concepts::BiCGStabFabric< F, G >::operator() ( Operator< F > &  matrix)
inlinevirtual

Implements concepts::SolverFabric< F >.

Definition at line 42 of file bicgstabFabric.hh.

◆ operator()() [3/3]

template<typename F , typename G = F>
virtual Operator< F > * concepts::BiCGStabFabric< F, G >::operator() ( Operator< F > &  matrix,
Operator< G > &  precond 
)
inlinevirtual

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 45 of file bicgstabFabric.hh.


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