Class documentation of Concepts

Loading...
Searching...
No Matches
eigensolver::SmallES< F > Class Template Reference

#include <SmallES.hh>

Inheritance diagram for eigensolver::SmallES< F >:
eigensolver::EigenSolver< F > concepts::OutputOperator

Public Member Functions

 SmallES (concepts::Array< F > &A)
 
template<class G >
 SmallES (concepts::Matrix< G > &A)
 
template<class G >
 SmallES (concepts::ElementMatrix< G > &A)
 
template<class G >
 SmallES (concepts::DenseMatrix< G > &A)
 
virtual ~SmallES ()
 
virtual const concepts::Array< F > & getEV ()
 
virtual const concepts::Array< concepts::Vector< F > * > & getEF ()
 
virtual uint iterations () const
 Returns the number of iterations.
 
virtual uint converged () const
 Returns the number of converged eigenpairs: (not implemented)
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Detailed Description

template<typename F = Cmplx>
class eigensolver::SmallES< F >

Eigenvalue solver using LaPack routine dgeev (Real) zgeev (Cmplx). This solver is intended to be applied to "small" general N by N matrices, e.g. for the eigenvalue computation in the DirPotIt routine. For Sparse matrices / big eigenvalue problems consider the ArPack routines. As input this solver takes: an array which represents the columnwise stored matrix: array(column 1, column 2,... column n), an ElementMatrix a Matrix IMPORTANT: If you use the real version of the algorithm, the eigenvalues are stored as an array of real values: array(Re(ev_1),...,Re(ev_n), Im(ev_1),..,Im(ev_n)). However, you can use a complex version for EementMatrix<Real> and Matrix<Real>.

Authors
: Peter Kauf, 2005 Vsevolod Shashkov, 2017

Definition at line 38 of file SmallES.hh.

Constructor & Destructor Documentation

◆ SmallES() [1/4]

template<typename F = Cmplx>
eigensolver::SmallES< F >::SmallES ( concepts::Array< F > &  A)

Constructor.

Parameters
AArray A is the matrix of which the eigenpairs have to be computed.

◆ SmallES() [2/4]

template<typename F = Cmplx>
template<class G >
eigensolver::SmallES< F >::SmallES ( concepts::Matrix< G > &  A)

Constructor.

Parameters
AMatrix A is the matrix of which the eigenpairs have to be computed.

◆ SmallES() [3/4]

template<typename F = Cmplx>
template<class G >
eigensolver::SmallES< F >::SmallES ( concepts::ElementMatrix< G > &  A)

Constructor.

Parameters
AElementMatrix A is the matrix of which the eigenpairs have to be computed.

◆ SmallES() [4/4]

template<typename F = Cmplx>
template<class G >
eigensolver::SmallES< F >::SmallES ( concepts::DenseMatrix< G > &  A)
inline

Constructor.

Parameters
ADenseMatrix A is the matrix of which the eigenpairs have to be computed.

Definition at line 66 of file SmallES.hh.

◆ ~SmallES()

template<typename F = Cmplx>
virtual eigensolver::SmallES< F >::~SmallES ( )
virtual

Destructor

Member Function Documentation

◆ converged()

template<typename F = Cmplx>
virtual uint eigensolver::SmallES< F >::converged ( ) const
inlinevirtual

Returns the number of converged eigenpairs: (not implemented)

Implements eigensolver::EigenSolver< F >.

Definition at line 85 of file SmallES.hh.

◆ getEF()

template<typename F = Cmplx>
virtual const concepts::Array< concepts::Vector< F > * > & eigensolver::SmallES< F >::getEF ( )
virtual

Returns an array with the eigenfunctions.

Implements eigensolver::EigenSolver< F >.

◆ getEV()

template<typename F = Cmplx>
virtual const concepts::Array< F > & eigensolver::SmallES< F >::getEV ( )
virtual

Returns an array with the real parts of the eigenvalues in the first kmax entries and the imaginary parts of the eigenvalues in the second kmax entries for real matrices and returns a complex array containing the eigenvalues for complex matrices. The last entry in both cases is the optimal size of the work array.

Implements eigensolver::EigenSolver< F >.

◆ info()

template<typename F = Cmplx>
virtual std::ostream & eigensolver::SmallES< F >::info ( std::ostream &  os) const
protectedvirtual

Returns information in an output stream.

Reimplemented from eigensolver::EigenSolver< F >.

◆ iterations()

template<typename F = Cmplx>
virtual uint eigensolver::SmallES< F >::iterations ( ) const
inlinevirtual

Returns the number of iterations.

Implements eigensolver::EigenSolver< F >.

Definition at line 83 of file SmallES.hh.


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