Alien  1.3.0
User documentation
Loading...
Searching...
No Matches
Alien::IGeneralizedEigenSolver Class Referenceabstract

Interface for generalized eigen solver. More...

#include <core/alien/expression/solver/IEigenSolver.h>

Public Member Functions

 IGeneralizedEigenSolver ()
 Constructor.
virtual ~IGeneralizedEigenSolver ()
 Free resources.
virtual bool solve (EigenProblem &problem)=0
 Solve an eigen problem.
virtual bool solve (GeneralizedEigenProblem &problem)=0
 Solve a generalized eigen problem.
Public Member Functions inherited from Alien::IEigenSolver
 IEigenSolver ()
 Constructor.
virtual ~IEigenSolver ()
 Free resources.
virtual Arccore::String getBackEndName () const =0
 Get back end name.
virtual void init ()=0
 Initialization.
virtual bool hasParallelSupport () const =0
virtual const StatusgetStatus () const =0
 Get solves status.

Additional Inherited Members

Public Types inherited from Alien::IEigenSolver
enum  eEigenValuesOrder {
  SmallestMagnitude , LargestMagnitude , SmallestReal , LargestReal ,
  SmallestImaginary , LargestImaginary
}
 Eigen values order. More...

Detailed Description

Interface for generalized eigen solver.

Definition at line 226 of file IEigenSolver.h.

Constructor & Destructor Documentation

◆ IGeneralizedEigenSolver()

Alien::IGeneralizedEigenSolver::IGeneralizedEigenSolver ( )
inline

Constructor.

Definition at line 230 of file IEigenSolver.h.

References Alien::IEigenSolver::IEigenSolver().

◆ ~IGeneralizedEigenSolver()

virtual Alien::IGeneralizedEigenSolver::~IGeneralizedEigenSolver ( )
inlinevirtual

Free resources.

Definition at line 235 of file IEigenSolver.h.

Member Function Documentation

◆ solve() [1/2]

virtual bool Alien::IGeneralizedEigenSolver::solve ( EigenProblem & problem)
pure virtual

Solve an eigen problem.

Parameters
[in]problemThe eigen problem
Returns
Whether or not the problem was solved

Implements Alien::IEigenSolver.

◆ solve() [2/2]

virtual bool Alien::IGeneralizedEigenSolver::solve ( GeneralizedEigenProblem & problem)
pure virtual

Solve a generalized eigen problem.

Parameters
[in]problemThe generalized eigen problem
Returns
Whether or not the problem was solved

Implemented in Alien::GeneralizedEigenSolver< Tag >.


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