AMDiS 2.10
The Adaptive Multi-Dimensional Simulation Toolbox
Classes | Public Member Functions | List of all members
Preconditioner< M, X, Y, PreconImpl > Class Template Reference

Wrapper for using ITL preconditioners in AMDiS. More...

#include <Preconditioner.hpp>

Inherits PreconditionerInterface< M, X, Y >.

Classes

struct  Creator
 A creator to be used instead of the constructor. More...
 

Public Member Functions

void init (M const &A) override
 Implementation of PreconditionerInterface::init() More...
 
void finish () override
 Implementation of PreconditionerInterface::finish() More...
 
void solve (X const &x, Y &y) const override
 Implementation of PreconditionerInterface::solve() More...
 
void adjoint_solve (X const &x, Y &y) const override
 Implementation of PreconditionerInterface::adjointSolve() More...
 
- Public Member Functions inherited from PreconditionerInterface< M, X, Y >
virtual ~PreconditionerInterface ()=default
 Virtual destructor.
 
virtual void init (M const &A)=0
 Is called a the beginning of a solution procedure. More...
 
virtual void finish ()=0
 Is called at the end of a solution procedure. More...
 
virtual void solve (X const &x, Y &y) const =0
 Apply the preconditioner to a vector x and store the result in y. More...
 
virtual void adjoint_solve (X const &x, Y &y) const
 Apply the transposed preconditioner to a vector x and store the result in y. More...
 

Detailed Description

template<class M, class X, class Y, template< class > class PreconImpl>
class AMDiS::Preconditioner< M, X, Y, PreconImpl >

Wrapper for using ITL preconditioners in AMDiS.

Member Function Documentation

◆ adjoint_solve()

void adjoint_solve ( X const &  x,
Y &  y 
) const
inlineoverridevirtual

Implementation of PreconditionerInterface::adjointSolve()

Reimplemented from PreconditionerInterface< M, X, Y >.

◆ finish()

void finish ( )
inlineoverridevirtual

Implementation of PreconditionerInterface::finish()

Implements PreconditionerInterface< M, X, Y >.

◆ init()

void init ( M const &  A)
inlineoverridevirtual

Implementation of PreconditionerInterface::init()

Implements PreconditionerInterface< M, X, Y >.

◆ solve()

void solve ( X const &  x,
Y &  y 
) const
inlineoverridevirtual

Implementation of PreconditionerInterface::solve()

Implements PreconditionerInterface< M, X, Y >.

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