Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::KernelSolverT< Tag > Class Template Referenceabstract
Collaboration diagram for Alien::KernelSolverT< Tag >:

Public Types

using MatrixType = typename AlgebraTraits<Tag>::matrix_type
 The type of the solver.
using VectorType = typename AlgebraTraits<Tag>::vector_type
using AlgebraType = typename AlgebraTraits<Tag>::algebra_type

Public Member Functions

virtual void init ()=0
virtual void start ()=0
virtual void end ()=0
virtual void init (MatrixType const &A)=0
 Initialize the linear solver.
virtual bool solve (const VectorType &b, VectorType &x)=0
 Solve the linear system A * x = b.

Detailed Description

template<class Tag>
class Alien::KernelSolverT< Tag >

Definition at line 30 of file KernelSolverT.h.

Member Typedef Documentation

◆ AlgebraType

template<class Tag>
using Alien::KernelSolverT< Tag >::AlgebraType = typename AlgebraTraits<Tag>::algebra_type

Definition at line 36 of file KernelSolverT.h.

◆ MatrixType

template<class Tag>
using Alien::KernelSolverT< Tag >::MatrixType = typename AlgebraTraits<Tag>::matrix_type

The type of the solver.

Definition at line 34 of file KernelSolverT.h.

◆ VectorType

template<class Tag>
using Alien::KernelSolverT< Tag >::VectorType = typename AlgebraTraits<Tag>::vector_type

Definition at line 35 of file KernelSolverT.h.

Constructor & Destructor Documentation

◆ ~KernelSolverT()

template<class Tag>
virtual Alien::KernelSolverT< Tag >::~KernelSolverT ( )
inlinevirtual

Definition at line 39 of file KernelSolverT.h.

Member Function Documentation

◆ solve()

template<class Tag>
virtual bool Alien::KernelSolverT< Tag >::solve ( const VectorType & b,
VectorType & x )
pure virtual

Solve the linear system A * x = b.

Parameters
[in]AThe matrix to invert
[in]bThe right hand side
[in,out]xThe solution
Returns
Solver success or failure

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