Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::IInternalEigenSolver< Matrix, Vector > Class Template Referenceabstract

Eigen solver interface. More...

#include <core/alien/core/backend/IInternalEigenSolverT.h>

Collaboration diagram for Alien::IInternalEigenSolver< Matrix, Vector >:

Public Member Functions

virtual ~IInternalEigenSolver ()
 Free resources.
virtual void init ()=0
 Initialize the eigen solver.
virtual bool solve (const EigenProblem &problem)=0
 Solve the eigen problem.
virtual bool hasParallelSupport () const =0
 Indicates if the kernel is parallel.
virtual const IEigenSolver::StatusgetStatus () const =0
 Get solver resolution status.

Detailed Description

template<class Matrix, class Vector>
class Alien::IInternalEigenSolver< Matrix, Vector >

Eigen solver interface.

Interface for all eigen solver package

Template Parameters
MatrixThe type of matrix used
VectorThe type of vector used

Definition at line 49 of file IInternalEigenSolverT.h.

Constructor & Destructor Documentation

◆ ~IInternalEigenSolver()

template<class Matrix, class Vector>
virtual Alien::IInternalEigenSolver< Matrix, Vector >::~IInternalEigenSolver ( )
inlinevirtual

Free resources.

Definition at line 53 of file IInternalEigenSolverT.h.

Member Function Documentation

◆ getStatus()

template<class Matrix, class Vector>
virtual const IEigenSolver::Status & Alien::IInternalEigenSolver< Matrix, Vector >::getStatus ( ) const
pure virtual

Get solver resolution status.

Returns
The solver status

◆ hasParallelSupport()

template<class Matrix, class Vector>
virtual bool Alien::IInternalEigenSolver< Matrix, Vector >::hasParallelSupport ( ) const
pure virtual

Indicates if the kernel is parallel.

Returns
Parallel support capability

◆ solve()

template<class Matrix, class Vector>
virtual bool Alien::IInternalEigenSolver< Matrix, Vector >::solve ( const EigenProblem & problem)
pure virtual

Solve the eigen problem.

Parameters
[in,out]problemThe eigen problem
Returns
Solver success status

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