Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::CGFabric< F > Class Template Reference

#include <cgFabric.hh>

Inheritance diagram for concepts::CGFabric< F >:
concepts::SolverFabric< F > concepts::OutputOperator

Public Member Functions

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

Protected Member Functions

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

Detailed Description

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

Fabric class for conjugate gradients: CG.

Author
Philipp Frauenfelder, 2002

Definition at line 27 of file cgFabric.hh.

Constructor & Destructor Documentation

◆ CGFabric()

template<typename F >
concepts::CGFabric< F >::CGFabric ( Real  maxeps = EPS,
int  maxit = 0,
bool  relres = false,
bool  throwing = true 
)
inline

Constructor.

Parameters
maxepsMaximal residual
maxitMaximal number of iterations
relresRelative residual
throwingIn the case of non convergence an exception is thrown and the best solution is not given back.

Definition at line 36 of file cgFabric.hh.

Member Function Documentation

◆ info()

template<typename F >
virtual std::ostream & concepts::CGFabric< F >::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Definition at line 44 of file cgFabric.hh.

◆ operator()() [1/2]

template<typename F >
Operator< F > * concepts::CGFabric< F >::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 42 of file cgFabric.hh.

◆ operator()() [2/2]

template<typename F >
virtual Operator< F > * concepts::CGFabric< F >::operator() ( Operator< F > &  matrix)
inlinevirtual

Implements concepts::SolverFabric< F >.

Definition at line 39 of file cgFabric.hh.


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