Reference documentation for deal.II version 8.5.1
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
EigenPower< VectorType > Class Template Reference

#include <deal.II/lac/eigen.h>

Inheritance diagram for EigenPower< VectorType >:
[legend]

Classes

struct  AdditionalData
 

Public Types

typedef types::global_dof_index size_type
 

Public Member Functions

 EigenPower (SolverControl &cn, VectorMemory< VectorType > &mem, const AdditionalData &data=AdditionalData())
 
virtual ~EigenPower ()
 
template<typename MatrixType >
void solve (double &value, const MatrixType &A, VectorType &x)
 

Protected Attributes

AdditionalData additional_data
 

Additional Inherited Members

- Private Types inherited from Solver< VectorType >
typedef VectorType vector_type
 
- Private Member Functions inherited from Solver< VectorType >
 Solver (SolverControl &solver_control, VectorMemory< VectorType > &vector_memory)
 
 Solver (SolverControl &solver_control)
 
boost::signals2::connection connect (const std_cxx11::function< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType &current_iterate)> &slot)
 
- Private Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
- Static Private Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, char *arg2, std::string &arg3)
 
static ::ExceptionBaseExcNoSubscriber (char *arg1, char *arg2)
 
- Private Attributes inherited from Solver< VectorType >
GrowingVectorMemory< VectorType > static_vector_memory
 
VectorMemory< VectorType > & memory
 
boost::signals2::signal< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType &current_iterate), StateCombineriteration_status
 

Detailed Description

template<typename VectorType = Vector<double>>
class EigenPower< VectorType >

Power method (von Mises) for eigenvalue computations.

This method determines the largest eigenvalue of a matrix by applying increasing powers of this matrix to a vector. If there is an eigenvalue \(l\) with dominant absolute value, the iteration vectors will become aligned to its eigenspace and \(Ax = lx\).

A shift parameter allows to shift the spectrum, so it is possible to compute the smallest eigenvalue, too.

Convergence of this method is known to be slow.

Author
Guido Kanschat, 2000

Definition at line 54 of file eigen.h.

Member Typedef Documentation

◆ size_type

template<typename VectorType = Vector<double>>
typedef types::global_dof_index EigenPower< VectorType >::size_type

Declare type of container size.

Definition at line 60 of file eigen.h.

Constructor & Destructor Documentation

◆ EigenPower()

template<class VectorType >
EigenPower< VectorType >::EigenPower ( SolverControl cn,
VectorMemory< VectorType > &  mem,
const AdditionalData data = AdditionalData() 
)

Constructor.

Definition at line 215 of file eigen.h.

◆ ~EigenPower()

template<class VectorType >
EigenPower< VectorType >::~EigenPower ( )
virtual

Virtual destructor.

Definition at line 226 of file eigen.h.

Member Function Documentation

◆ solve()

template<class VectorType >
template<typename MatrixType >
void EigenPower< VectorType >::solve ( double &  value,
const MatrixType &  A,
VectorType &  x 
)

Power method. x is the (not necessarily normalized, but nonzero) start vector for the power method. After the iteration, value is the approximated eigenvalue and x is the corresponding eigenvector, normalized with respect to the l2-norm.

Definition at line 234 of file eigen.h.

Member Data Documentation

◆ additional_data

template<typename VectorType = Vector<double>>
AdditionalData EigenPower< VectorType >::additional_data
protected

Shift parameter.

Definition at line 110 of file eigen.h.


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