Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::GeneralizedEigenProblem Class Reference

Defines a generalized eigen problem. More...

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

Inheritance diagram for Alien::GeneralizedEigenProblem:
Collaboration diagram for Alien::GeneralizedEigenProblem:

Public Member Functions

 GeneralizedEigenProblem (IMatrix const &A, IMatrix const &B)
 Constructor.
virtual ~GeneralizedEigenProblem ()
 Free resources.
IMatrix const & getB () const
 Get the second matrix.
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.
virtual Arccore::Integer getNbEigenVectors () const =0
 Get the number of eigen vectors.

Protected Attributes

IMatrix const & m_B
 The second matrix.
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

Defines a generalized eigen problem.

Definition at line 124 of file IEigenSolver.h.

Constructor & Destructor Documentation

◆ GeneralizedEigenProblem()

Alien::GeneralizedEigenProblem::GeneralizedEigenProblem ( IMatrix const & A,
IMatrix const & B )
inline

Constructor.

Parameters
[in]AThe first matrix
[in]BThe second matrix

Definition at line 132 of file IEigenSolver.h.

References Alien::EigenProblem::EigenProblem(), and m_B.

Referenced by Alien::GeneralizedEigenProblemT< Tag, VectorT >::GeneralizedEigenProblemT().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~GeneralizedEigenProblem()

virtual Alien::GeneralizedEigenProblem::~GeneralizedEigenProblem ( )
inlinevirtual

Free resources.

Definition at line 138 of file IEigenSolver.h.

Member Function Documentation

◆ getB()

IMatrix const & Alien::GeneralizedEigenProblem::getB ( ) const
inline

Get the second matrix.

Returns
The second matrix

Definition at line 144 of file IEigenSolver.h.

References m_B.

Member Data Documentation

◆ m_B

IMatrix const& Alien::GeneralizedEigenProblem::m_B
protected

The second matrix.

Definition at line 148 of file IEigenSolver.h.

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

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