Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::EigenProblemT< Tag, VectorT > Class Template Reference

Eigen problem definition. More...

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

Inheritance diagram for Alien::EigenProblemT< Tag, VectorT >:
Collaboration diagram for Alien::EigenProblemT< Tag, VectorT >:

Public Types

typedef AlgebraTraits< Tag >::matrix_type KernelMatrix
 Type of the matrix used.
typedef AlgebraTraits< Tag >::vector_type KernelVector
 Type of the vector used.

Public Member Functions

 EigenProblemT (IMatrix const &A)
 Eigen problem constructor.
virtual ~EigenProblemT ()
 Free resources.
Arccore::Integer localSize () const
 Get the local size of the problem.
KernelMatrix const & getA () const
 Get the eigen matrix.
Arccore::Integer getNbEigenVectors () const
 Get the number of eigen vectors.
std::vector< VectorT > & getEigenVectors ()
 Get the eigen vectors.
Public Member Functions inherited from Alien::EigenProblem
 EigenProblem (IMatrix const &A)
 Constructor.
virtual ~EigenProblem ()
 Free resources.
IMatrix const & getA () const
 Get the matrix.
std::vector< Arccore::Real > const & getRealEigenValues () const
 Get real eigen values.
std::vector< Arccore::Real > & getRealEigenValues ()
 Get real eigen values.
std::vector< Arccore::Real > const & getImaginaryEigenValues () const
 Get imaginary eigen values.
std::vector< Arccore::Real > & getImaginaryEigenValues ()
 Get imaginary eigen values.

Private Attributes

std::vector< VectorT > m_eigen_vectors
 Eigen vectors.

Additional Inherited Members

Protected Attributes inherited from Alien::EigenProblem
IMatrix const & m_A
 The eigen matrix.
std::vector< Arccore::Real > m_real_eigen_values
 The real eigen values.
std::vector< Arccore::Real > m_imaginary_eigen_values
 The imaginary eigen values.

Detailed Description

template<class Tag, typename VectorT>
class Alien::EigenProblemT< Tag, VectorT >

Eigen problem definition.

Allows to specify the matrix and get the number of eigen vectors as well as the eigen vectors

Template Parameters
TagThe type of kernel used to compute eigen values
VectorTThe type of kernel used to store eigen vectors

Definition at line 46 of file EigenSolver.h.

Member Typedef Documentation

◆ KernelMatrix

template<class Tag, typename VectorT>
typedef AlgebraTraits<Tag>::matrix_type Alien::EigenProblemT< Tag, VectorT >::KernelMatrix

Type of the matrix used.

Definition at line 61 of file EigenSolver.h.

◆ KernelVector

template<class Tag, typename VectorT>
typedef AlgebraTraits<Tag>::vector_type Alien::EigenProblemT< Tag, VectorT >::KernelVector

Type of the vector used.

Definition at line 63 of file EigenSolver.h.

Constructor & Destructor Documentation

◆ EigenProblemT()

template<class Tag, typename VectorT>
Alien::EigenProblemT< Tag, VectorT >::EigenProblemT ( IMatrix const & A)
inline

Eigen problem constructor.

Parameters
[in]AThe matrix of the eigen problem

Definition at line 53 of file EigenSolver.h.

References Alien::EigenProblem::EigenProblem().

Here is the call graph for this function:

◆ ~EigenProblemT()

template<class Tag, typename VectorT>
virtual Alien::EigenProblemT< Tag, VectorT >::~EigenProblemT ( )
inlinevirtual

Free resources.

Definition at line 58 of file EigenSolver.h.

Member Function Documentation

◆ getA()

template<class TagT, typename VectorT>
EigenProblemT< TagT, VectorT >::KernelMatrix const & Alien::EigenProblemT< TagT, VectorT >::getA ( ) const

Get the eigen matrix.

Returns
The eigen matrix

Definition at line 54 of file EigenSolverT.h.

References Alien::EigenProblem::m_A.

◆ getEigenVectors()

template<class Tag, typename VectorT>
std::vector< VectorT > & Alien::EigenProblemT< Tag, VectorT >::getEigenVectors ( )
inline

Get the eigen vectors.

Returns
The eigen vectors

Definition at line 87 of file EigenSolver.h.

References m_eigen_vectors.

◆ getNbEigenVectors()

template<class Tag, typename VectorT>
Arccore::Integer Alien::EigenProblemT< Tag, VectorT >::getNbEigenVectors ( ) const
inlinevirtual

Get the number of eigen vectors.

Returns
The number of eigen vectors

Implements Alien::EigenProblem.

Definition at line 81 of file EigenSolver.h.

References m_eigen_vectors.

◆ localSize()

template<class TagT, typename VectorT>
Integer Alien::EigenProblemT< TagT, VectorT >::localSize ( ) const

Get the local size of the problem.

Returns
Local size of the problem

Definition at line 44 of file EigenSolverT.h.

References Alien::EigenProblem::m_A.

Member Data Documentation

◆ m_eigen_vectors

template<class Tag, typename VectorT>
std::vector<VectorT> Alien::EigenProblemT< Tag, VectorT >::m_eigen_vectors
private

Eigen vectors.

Definition at line 108 of file EigenSolver.h.

Referenced by getEigenVectors(), and getNbEigenVectors().

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