Alien::IEigenSolver Class Reference

Eigen solver interface. More...

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

Inheritance diagram for Alien::IEigenSolver:

Collaboration diagram for Alien::IEigenSolver:

Classes
struct	Status
	Eigen solver status. More...

Public Types
enum	eEigenValuesOrder {   SmallestMagnitude , LargestMagnitude , SmallestReal , LargestReal ,   SmallestImaginary , LargestImaginary }
	Eigen values order. More...

Public Member Functions
	IEigenSolver ()
	Constructor.
virtual	~IEigenSolver ()
	Free resources.
virtual Arccore::String	getBackEndName () const =0
	Get back end name.
virtual void	init ()=0
	Initialization.
virtual bool	solve (EigenProblem &problem)=0
	Solves an eigen problem.
virtual bool	hasParallelSupport () const =0
virtual const Status &	getStatus () const =0
	Get solves status.

Detailed Description

Eigen solver interface.

Definition at line 158 of file IEigenSolver.h.

Member Enumeration Documentation

eEigenValuesOrder

enum Alien::IEigenSolver::eEigenValuesOrder

Eigen values order.

Definition at line 172 of file IEigenSolver.h.

Constructor & Destructor Documentation

IEigenSolver()

Alien::IEigenSolver::IEigenSolver ( )

inline

Constructor.

Definition at line 184 of file IEigenSolver.h.

Referenced by Alien::IGeneralizedEigenSolver::IGeneralizedEigenSolver().

Here is the caller graph for this function:

~IEigenSolver()

virtual Alien::IEigenSolver::~IEigenSolver ( )

inlinevirtual

Free resources.

Definition at line 187 of file IEigenSolver.h.

Member Function Documentation

getBackEndName()

virtual Arccore::String Alien::IEigenSolver::getBackEndName ( ) const

pure virtual

Get back end name.

Returns

The back end name

Implemented in Alien::EigenSolver< Tag >, and Alien::GeneralizedEigenSolver< Tag >.

getStatus()

virtual const Status & Alien::IEigenSolver::getStatus ( ) const

pure virtual

Get solves status.

Returns

Solver status

Implemented in Alien::EigenSolver< Tag >, and Alien::GeneralizedEigenSolver< Tag >.

hasParallelSupport()

virtual bool Alien::IEigenSolver::hasParallelSupport ( ) const

pure virtual

Implemented in Alien::EigenSolver< Tag >, and Alien::GeneralizedEigenSolver< Tag >.

init()

virtual void Alien::IEigenSolver::init ( )

pure virtual

Initialization.

Implemented in Alien::EigenSolver< Tag >, and Alien::GeneralizedEigenSolver< Tag >.

solve()

virtual bool Alien::IEigenSolver::solve ( EigenProblem & problem )

pure virtual

Solves an eigen problem.

Parameters

[in]

problem

The eigen problem

Returns

Whether or not the solver succeeded

Implemented in Alien::EigenSolver< Tag >, and Alien::IGeneralizedEigenSolver.

---

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

• IEigenSolver.h