G+Smo  24.08.0
Geometry + Simulation Modules
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AbstractIterativeSolver Class Referenceabstract

Detailed Description

Abstract iterative solver base class.

This abstract base class defines the set of additional attributes and methods that must be implemented by all iterative solvers.

+ Inheritance diagram for AbstractIterativeSolver:
+ Collaboration diagram for AbstractIterativeSolver:

Public Member Functions

 AbstractIterativeSolver ()
 Constructors. More...
 
 AbstractIterativeSolver (const SparseMatrix &A)
 Constructor (sparse matrix)
 
virtual std::string currentParams () const =0
 Returns information about current parameters.
 
void getSolution (gsVector< real_t > &sol, const int rank=0) const
 Returns solution vector.
 
virtual void set (const std::string &name, const int &value)=0
 Sets parameters.
 
void setOptions (const gsOptionList &opt)
 Set parameters from option list. More...
 
const Vector & solve (const Vector &b)
 Solves problem for the given a right-hand side vector.
 
virtual std::string status () const =0
 Returns status of the solver.
 
virtual std::string timing () const =0
 Returns timing of the solver.
 
virtual std::string validParams () const =0
 Returns information about valid parameters.
 

Protected Member Functions

virtual int numIterations () const =0
 Returns number of iterations.
 
virtual void solveProblem ()=0
 Solves problem. More...
 

Protected Attributes

int maxIter
 Default maximum number of iterations for all iterative solvers.
 
double tolerance
 Default tolerance for all iterative solvers.
 

Constructor & Destructor Documentation

Constructors.

No difference to AbstractSolver.

Constructor (default)

Member Function Documentation

void setOptions ( const gsOptionList opt)
inherited

Set parameters from option list.

Sets parameters from option list.

virtual void solveProblem ( )
protectedpure virtualinherited

Solves problem.

Get parameters into option list void getOptions(const gsOptionList & opt);

Implemented in MLSolver, BelosSolver, AztecSolver, and AmesosSolver.