Reference documentation for deal.II version Git ac854ef673 2021-03-06 10:09:45 +0100
EigenPower< VectorType > Class Template Reference

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

Inheritance diagram for EigenPower< VectorType >:
[legend]

## Public Types

using size_type = types::global_dof_index

## Public Member Functions

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

## Private Types

using vector_type = VectorType

## Private Member Functions

boost::signals2::connection connect (const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType &current_iterate)> &slot)

template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int n_subscriptions () const

template<typename StreamType >
void list_subscribers (StreamType &stream) const

void list_subscribers () const

## Static Private Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Private Attributes

GrowingVectorMemory< VectorTypestatic_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.

Definition at line 53 of file eigen.h.

## ◆ size_type

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

Declare type of container size.

Definition at line 59 of file eigen.h.

## ◆ vector_type

template<class VectorType = Vector<double>>
 using SolverBase< VectorType >::vector_type = VectorType
inherited

An alias for the underlying vector type

Definition at line 347 of file solver.h.

## ◆ EigenPower()

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

Constructor.

Definition at line 194 of file eigen.h.

## ◆ 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 206 of file eigen.h.

## ◆ connect()

template<class VectorType >
 boost::signals2::connection SolverBase< VectorType >::connect ( const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType ¤t_iterate)> & slot )
inlineinherited

Connect a function object that will be called periodically within iterative solvers. This function is used to attach monitors to iterative solvers, either to determine when convergence has happened, or simply to observe the progress of an iteration. See the documentation of this class for more information.

Parameters
 slot A function object specified here will, with each call, receive the number of the current iteration, the value that is used to check for convergence (typically the residual of the current iterate with respect to the linear system to be solved) and the currently best available guess for the current iterate. Note that some solvers do not update the approximate solution in every iteration but only after convergence or failure has been determined (GMRES is an example); in such cases, the vector passed as the last argument to the signal is simply the best approximate at the time the signal is called, but not the vector that will be returned if the signal's return value indicates that the iteration should be terminated. The function object must return a SolverControl::State value that indicates whether the iteration should continue, has failed, or has succeeded. The results of all connected functions will then be combined to determine what should happen with the iteration.
Returns
A connection object that represents the connection from the signal to the function object. It can be used to disconnect the function object again from the signal. See the documentation of the BOOST Signals2 library for more information on connection management.

Definition at line 554 of file solver.h.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 301 of file subscriptor.h.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

## ◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 310 of file subscriptor.h.

## Member Data Documentation

template<typename VectorType = Vector<double>>
protected

Shift parameter.

Definition at line 101 of file eigen.h.

## ◆ static_vector_memory

template<class VectorType = Vector<double>>
 GrowingVectorMemory SolverBase< VectorType >::static_vector_memory
mutableprotectedinherited

A static vector memory object to be used whenever no such object has been given to the constructor.

Definition at line 415 of file solver.h.

## ◆ memory

template<class VectorType = Vector<double>>
 VectorMemory& SolverBase< VectorType >::memory
protectedinherited

A reference to an object that provides memory for auxiliary vectors.

Definition at line 420 of file solver.h.

## ◆ iteration_status

template<class VectorType = Vector<double>>
 boost::signals2::signal< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType & current_iterate), StateCombiner> SolverBase< VectorType >::iteration_status
protectedinherited

A signal that iterative solvers can execute at the end of every iteration (or in an otherwise periodic fashion) to find out whether we should continue iterating or not. The signal may call one or more slots that each will make this determination by themselves, and the result over all slots (function calls) will be determined by the StateCombiner object.

The arguments passed to the signal are (i) the number of the current iteration; (ii) the value that is used to determine convergence (oftentimes the residual, but in other cases other quantities may be used as long as they converge to zero as the iterate approaches the solution of the linear system); and (iii) a vector that corresponds to the current best guess for the solution at the point where the signal is called. Note that some solvers do not update the approximate solution in every iteration but only after convergence or failure has been determined (GMRES is an example); in such cases, the vector passed as the last argument to the signal is simply the best approximate at the time the signal is called, but not the vector that will be returned if the signal's return value indicates that the iteration should be terminated.

Definition at line 471 of file solver.h.

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