Alien::EigenProblem Class Reference

Defines an eigen problem. More...

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

Inheritance diagram for Alien::EigenProblem:

Collaboration diagram for Alien::EigenProblem:

Public Member Functions
	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.
virtual Arccore::Integer	getNbEigenVectors () const =0
	Get the number of eigen vectors.

Protected Attributes
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

Defines an eigen problem.

Definition at line 49 of file IEigenSolver.h.

Constructor & Destructor Documentation

EigenProblem()

Alien::EigenProblem::EigenProblem ( IMatrix const & A )

inline

Constructor.

Parameters

[in]

A

The matrix

Definition at line 56 of file IEigenSolver.h.

References m_A.

Referenced by Alien::EigenProblemT< Tag, VectorT >::EigenProblemT(), and Alien::GeneralizedEigenProblem::GeneralizedEigenProblem().

Here is the caller graph for this function:

~EigenProblem()

virtual Alien::EigenProblem::~EigenProblem ( )

inlinevirtual

Free resources.

Definition at line 61 of file IEigenSolver.h.

Member Function Documentation

getA()

IMatrix const & Alien::EigenProblem::getA ( ) const

inline

Get the matrix.

Returns

The matrix

Definition at line 67 of file IEigenSolver.h.

References m_A.

getImaginaryEigenValues() [1/2]

std::vector< Arccore::Real > & Alien::EigenProblem::getImaginaryEigenValues ( )

inline

Get imaginary eigen values.

Returns

The imaginary eigen values

Definition at line 97 of file IEigenSolver.h.

References m_imaginary_eigen_values.

getImaginaryEigenValues() [2/2]

std::vector< Arccore::Real > const & Alien::EigenProblem::getImaginaryEigenValues ( ) const

inline

Get imaginary eigen values.

Returns

The imaginary eigen values

Definition at line 88 of file IEigenSolver.h.

References m_imaginary_eigen_values.

getNbEigenVectors()

virtual Arccore::Integer Alien::EigenProblem::getNbEigenVectors ( ) const

pure virtual

Get the number of eigen vectors.

Returns

The number of eigen vectors

Implemented in Alien::EigenProblemT< Tag, VectorT >, and Alien::GeneralizedEigenProblemT< Tag, VectorT >.

getRealEigenValues() [1/2]

std::vector< Arccore::Real > & Alien::EigenProblem::getRealEigenValues ( )

inline

Get real eigen values.

Returns

The real eigen values

Definition at line 82 of file IEigenSolver.h.

References m_real_eigen_values.

getRealEigenValues() [2/2]

std::vector< Arccore::Real > const & Alien::EigenProblem::getRealEigenValues ( ) const

inline

Get real eigen values.

Returns

The real eigen values

Definition at line 73 of file IEigenSolver.h.

References m_real_eigen_values.

Member Data Documentation

m_A

IMatrix const& Alien::EigenProblem::m_A

protected

The eigen matrix.

Definition at line 110 of file IEigenSolver.h.

Referenced by EigenProblem(), getA(), Alien::EigenProblemT< Tag, VectorT >::getA(), Alien::GeneralizedEigenProblemT< Tag, VectorT >::getA(), Alien::EigenProblemT< Tag, VectorT >::localSize(), and Alien::GeneralizedEigenProblemT< Tag, VectorT >::localSize().

m_imaginary_eigen_values

std::vector<Arccore::Real> Alien::EigenProblem::m_imaginary_eigen_values

protected

The imaginary eigen values.

Definition at line 114 of file IEigenSolver.h.

Referenced by getImaginaryEigenValues(), and getImaginaryEigenValues().

m_real_eigen_values

std::vector<Arccore::Real> Alien::EigenProblem::m_real_eigen_values

protected

The real eigen values.

Definition at line 112 of file IEigenSolver.h.

Referenced by getRealEigenValues(), and getRealEigenValues().

---

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

• IEigenSolver.h