ug4
Public Types | Public Member Functions | Public Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
ug::PowerMethod< TAlgebra > Class Template Reference

#include <power_method.h>

Public Types

typedef TAlgebra algebra_type
 
typedef TAlgebra::matrix_type matrix_type
 
typedef TAlgebra::vector_type vector_type
 
typedef vector_type::value_type vector_value_type
 

Public Member Functions

int calculate_max_eigenvalue ()
 
int calculate_min_eigenvalue ()
 
size_t get_iterations ()
 
double get_max_eigenvalue ()
 
double get_min_eigenvalue ()
 
 PowerMethod ()
 
void print_eigenvector ()
 
void print_matrix_A ()
 
void print_matrix_B ()
 
void set_linear_operator_A (SmartPtr< ILinearOperator< vector_type > > loA)
 
void set_linear_operator_B (SmartPtr< ILinearOperator< vector_type > > loB)
 
void set_max_iterations (size_t maxIterations)
 
void set_precision (double precision)
 
void set_solver (SmartPtr< ILinearOperatorInverse< vector_type > > solver)
 
void set_start_vector (SmartPtr< vector_type > vec)
 

Public Attributes

size_t m_iteration
 

Private Types

typedef IPreconditioner< TAlgebra >::matrix_operator_type matrix_operator_type
 

Private Member Functions

double B_norm (vector_type &x)
 
SmartPtr< vector_type > create_approximation_vector ()
 
void normalize_approximations ()
 

Private Attributes

double m_dMaxEigenvalue
 
double m_dMinEigenvalue
 
double m_dPrecision
 
size_t m_maxIterations
 
int m_numDirichletRows
 
SmartPtr< vector_type > m_spEigenvector
 
SmartPtr< vector_type > m_spEigenvectorOld
 
SmartPtr< ILinearOperator< vector_type > > m_spLinOpA
 
SmartPtr< ILinearOperator< vector_type > > m_spLinOpB
 
SmartPtr< matrix_operator_type > m_spMatOpA
 
SmartPtr< matrix_operator_type > m_spMatOpB
 
SmartPtr< vector_type > m_spResidual
 
SmartPtr< ILinearOperatorInverse< vector_type > > m_spSolver
 
std::vector< bool > m_vbDirichlet
 

Detailed Description

template<typename TAlgebra>
class ug::PowerMethod< TAlgebra >

Power Method Eigensolver

The Power Method solves generalized eigenvalue problems of the form A v = lambda B v calculating the largest/smallest (in terms of abs(lambda)) eigenvalues of the problem for sparse matrices A and B which e.g. emerge from FE or FV discretizations.

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >
typedef TAlgebra ug::PowerMethod< TAlgebra >::algebra_type

◆ matrix_operator_type

template<typename TAlgebra >
typedef IPreconditioner<TAlgebra>::matrix_operator_type ug::PowerMethod< TAlgebra >::matrix_operator_type
private

◆ matrix_type

template<typename TAlgebra >
typedef TAlgebra::matrix_type ug::PowerMethod< TAlgebra >::matrix_type

◆ vector_type

template<typename TAlgebra >
typedef TAlgebra::vector_type ug::PowerMethod< TAlgebra >::vector_type

◆ vector_value_type

template<typename TAlgebra >
typedef vector_type::value_type ug::PowerMethod< TAlgebra >::vector_value_type

Constructor & Destructor Documentation

◆ PowerMethod()

template<typename TAlgebra >
ug::PowerMethod< TAlgebra >::PowerMethod ( )
inline

References ug::PowerMethod< TAlgebra >::m_dMaxEigenvalue, ug::PowerMethod< TAlgebra >::m_dMinEigenvalue, ug::PowerMethod< TAlgebra >::m_dPrecision, ug::PowerMethod< TAlgebra >::m_iteration, ug::PowerMethod< TAlgebra >::m_maxIterations, ug::PowerMethod< TAlgebra >::m_numDirichletRows, ug::PowerMethod< TAlgebra >::m_spLinOpA, ug::PowerMethod< TAlgebra >::m_spLinOpB, ug::PowerMethod< TAlgebra >::m_spMatOpA, ug::PowerMethod< TAlgebra >::m_spMatOpB, SPNULL, and UG_LOG.

Member Function Documentation

◆ B_norm()

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::B_norm ( vector_type &  x)
inlineprivate

References ug::EnergyNorm(), ug::PowerMethod< TAlgebra >::m_spMatOpB, and SPNULL.

Referenced by ug::PowerMethod< TAlgebra >::normalize_approximations().

◆ calculate_max_eigenvalue()

template<typename TAlgebra >
int ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue ( )
inline

References ug::PowerMethod< TAlgebra >::create_approximation_vector(), ug::PowerMethod< TAlgebra >::m_dMaxEigenvalue, ug::PowerMethod< TAlgebra >::m_dPrecision, ug::PowerMethod< TAlgebra >::m_iteration, ug::PowerMethod< TAlgebra >::m_maxIterations, ug::PowerMethod< TAlgebra >::m_spEigenvector, ug::PowerMethod< TAlgebra >::m_spEigenvectorOld, ug::PowerMethod< TAlgebra >::m_spLinOpA, ug::PowerMethod< TAlgebra >::m_spLinOpB, ug::PowerMethod< TAlgebra >::m_spResidual, ug::PowerMethod< TAlgebra >::m_spSolver, ug::PowerMethod< TAlgebra >::m_vbDirichlet, ug::PowerMethod< TAlgebra >::normalize_approximations(), PROFILE_FUNC_GROUP, ug::PST_CONSISTENT, SPNULL, UG_COND_THROW, UG_LOG, and ug::VecScaleAdd().

◆ calculate_min_eigenvalue()

template<typename TAlgebra >
int ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue ( )
inline

References ug::PowerMethod< TAlgebra >::create_approximation_vector(), ug::PowerMethod< TAlgebra >::m_dMinEigenvalue, ug::PowerMethod< TAlgebra >::m_dPrecision, ug::PowerMethod< TAlgebra >::m_iteration, ug::PowerMethod< TAlgebra >::m_maxIterations, ug::PowerMethod< TAlgebra >::m_spEigenvector, ug::PowerMethod< TAlgebra >::m_spEigenvectorOld, ug::PowerMethod< TAlgebra >::m_spLinOpA, ug::PowerMethod< TAlgebra >::m_spLinOpB, ug::PowerMethod< TAlgebra >::m_spResidual, ug::PowerMethod< TAlgebra >::m_spSolver, ug::PowerMethod< TAlgebra >::m_vbDirichlet, ug::PowerMethod< TAlgebra >::normalize_approximations(), PROFILE_FUNC_GROUP, ug::PST_ADDITIVE, ug::PST_CONSISTENT, SPNULL, UG_COND_THROW, UG_LOG, and ug::VecScaleAdd().

◆ create_approximation_vector()

template<typename TAlgebra >
SmartPtr<vector_type> ug::PowerMethod< TAlgebra >::create_approximation_vector ( )
inlineprivate

References ug::PowerMethod< TAlgebra >::m_spEigenvector.

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), and ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue().

◆ get_iterations()

template<typename TAlgebra >
size_t ug::PowerMethod< TAlgebra >::get_iterations ( )
inline

References ug::PowerMethod< TAlgebra >::m_iteration.

◆ get_max_eigenvalue()

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::get_max_eigenvalue ( )
inline

References ug::PowerMethod< TAlgebra >::m_dMaxEigenvalue.

◆ get_min_eigenvalue()

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::get_min_eigenvalue ( )
inline

References ug::PowerMethod< TAlgebra >::m_dMinEigenvalue.

◆ normalize_approximations()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::normalize_approximations ( )
inlineprivate

References ug::PowerMethod< TAlgebra >::B_norm(), and ug::PowerMethod< TAlgebra >::m_spEigenvector.

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), and ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue().

◆ print_eigenvector()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::print_eigenvector ( )
inline

References ug::PowerMethod< TAlgebra >::m_spEigenvector.

◆ print_matrix_A()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::print_matrix_A ( )
inline

References ug::PowerMethod< TAlgebra >::m_spMatOpA, and ug::PrintMatrix().

◆ print_matrix_B()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::print_matrix_B ( )
inline

References ug::PowerMethod< TAlgebra >::m_spMatOpB, and ug::PrintMatrix().

◆ set_linear_operator_A()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_linear_operator_A ( SmartPtr< ILinearOperator< vector_type > >  loA)
inline

References ug::PowerMethod< TAlgebra >::m_numDirichletRows, ug::PowerMethod< TAlgebra >::m_spLinOpA, ug::PowerMethod< TAlgebra >::m_spMatOpA, and ug::PowerMethod< TAlgebra >::m_vbDirichlet.

◆ set_linear_operator_B()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_linear_operator_B ( SmartPtr< ILinearOperator< vector_type > >  loB)
inline

References ug::PowerMethod< TAlgebra >::m_spLinOpB, and ug::PowerMethod< TAlgebra >::m_spMatOpB.

◆ set_max_iterations()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_max_iterations ( size_t  maxIterations)
inline

References ug::PowerMethod< TAlgebra >::m_maxIterations.

◆ set_precision()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_precision ( double  precision)
inline

References ug::PowerMethod< TAlgebra >::m_dPrecision.

◆ set_solver()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_solver ( SmartPtr< ILinearOperatorInverse< vector_type > >  solver)
inline

References ug::PowerMethod< TAlgebra >::m_spSolver.

◆ set_start_vector()

template<typename TAlgebra >
void ug::PowerMethod< TAlgebra >::set_start_vector ( SmartPtr< vector_type >  vec)
inline

References ug::PowerMethod< TAlgebra >::m_spEigenvector.

Member Data Documentation

◆ m_dMaxEigenvalue

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::m_dMaxEigenvalue
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::get_max_eigenvalue(), and ug::PowerMethod< TAlgebra >::PowerMethod().

◆ m_dMinEigenvalue

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::m_dMinEigenvalue
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::get_min_eigenvalue(), and ug::PowerMethod< TAlgebra >::PowerMethod().

◆ m_dPrecision

template<typename TAlgebra >
double ug::PowerMethod< TAlgebra >::m_dPrecision
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::PowerMethod(), and ug::PowerMethod< TAlgebra >::set_precision().

◆ m_iteration

template<typename TAlgebra >
size_t ug::PowerMethod< TAlgebra >::m_iteration

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::get_iterations(), and ug::PowerMethod< TAlgebra >::PowerMethod().

◆ m_maxIterations

template<typename TAlgebra >
size_t ug::PowerMethod< TAlgebra >::m_maxIterations
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::PowerMethod(), and ug::PowerMethod< TAlgebra >::set_max_iterations().

◆ m_numDirichletRows

template<typename TAlgebra >
int ug::PowerMethod< TAlgebra >::m_numDirichletRows
private

Referenced by ug::PowerMethod< TAlgebra >::PowerMethod(), and ug::PowerMethod< TAlgebra >::set_linear_operator_A().

◆ m_spEigenvector

template<typename TAlgebra >
SmartPtr<vector_type> ug::PowerMethod< TAlgebra >::m_spEigenvector
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::create_approximation_vector(), ug::PowerMethod< TAlgebra >::normalize_approximations(), ug::PowerMethod< TAlgebra >::print_eigenvector(), and ug::PowerMethod< TAlgebra >::set_start_vector().

◆ m_spEigenvectorOld

template<typename TAlgebra >
SmartPtr<vector_type> ug::PowerMethod< TAlgebra >::m_spEigenvectorOld
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), and ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue().

◆ m_spLinOpA

template<typename TAlgebra >
SmartPtr<ILinearOperator<vector_type> > ug::PowerMethod< TAlgebra >::m_spLinOpA
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::PowerMethod(), and ug::PowerMethod< TAlgebra >::set_linear_operator_A().

◆ m_spLinOpB

template<typename TAlgebra >
SmartPtr<ILinearOperator<vector_type> > ug::PowerMethod< TAlgebra >::m_spLinOpB
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), ug::PowerMethod< TAlgebra >::PowerMethod(), and ug::PowerMethod< TAlgebra >::set_linear_operator_B().

◆ m_spMatOpA

template<typename TAlgebra >
SmartPtr<matrix_operator_type> ug::PowerMethod< TAlgebra >::m_spMatOpA
private

Referenced by ug::PowerMethod< TAlgebra >::PowerMethod(), ug::PowerMethod< TAlgebra >::print_matrix_A(), and ug::PowerMethod< TAlgebra >::set_linear_operator_A().

◆ m_spMatOpB

template<typename TAlgebra >
SmartPtr<matrix_operator_type> ug::PowerMethod< TAlgebra >::m_spMatOpB
private

Referenced by ug::PowerMethod< TAlgebra >::B_norm(), ug::PowerMethod< TAlgebra >::PowerMethod(), ug::PowerMethod< TAlgebra >::print_matrix_B(), and ug::PowerMethod< TAlgebra >::set_linear_operator_B().

◆ m_spResidual

template<typename TAlgebra >
SmartPtr<vector_type> ug::PowerMethod< TAlgebra >::m_spResidual
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), and ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue().

◆ m_spSolver

template<typename TAlgebra >
SmartPtr<ILinearOperatorInverse<vector_type> > ug::PowerMethod< TAlgebra >::m_spSolver
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), and ug::PowerMethod< TAlgebra >::set_solver().

◆ m_vbDirichlet

template<typename TAlgebra >
std::vector<bool> ug::PowerMethod< TAlgebra >::m_vbDirichlet
private

Referenced by ug::PowerMethod< TAlgebra >::calculate_max_eigenvalue(), ug::PowerMethod< TAlgebra >::calculate_min_eigenvalue(), and ug::PowerMethod< TAlgebra >::set_linear_operator_A().

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