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

Generalized eigen solver internal. More...

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

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

Public Member Functions

virtual ~IInternalGeneralizedEigenSolver ()
 Free resources.
virtual void init ()=0
 Initialize the eigen solver.
virtual bool solve (const GeneralizedEigenProblem &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::IInternalGeneralizedEigenSolver< Matrix, Vector >

Generalized eigen solver internal.

Interface for all generalized eigen solver package

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

Definition at line 91 of file IInternalEigenSolverT.h.

Constructor & Destructor Documentation

◆ ~IInternalGeneralizedEigenSolver()

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

Free resources.

Definition at line 95 of file IInternalEigenSolverT.h.

Member Function Documentation

◆ getStatus()

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

Get solver resolution status.

Returns
The solver status

◆ hasParallelSupport()

template<class Matrix, class Vector>
virtual bool Alien::IInternalGeneralizedEigenSolver< 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::IInternalGeneralizedEigenSolver< Matrix, Vector >::solve ( const GeneralizedEigenProblem & 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: