Reference documentation for deal.II version Git 35565f205e 2019-09-24 08:33:37 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Member Functions | List of all members
SolverRelaxation< VectorType > Class Template Reference

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

Inheritance diagram for SolverRelaxation< VectorType >:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 SolverRelaxation (SolverControl &cn, const AdditionalData &data=AdditionalData())
 
virtual ~SolverRelaxation ()
 
template<typename MatrixType , class RelaxationType >
void solve (const MatrixType &A, VectorType &x, const VectorType &b, const RelaxationType &R)
 
- Public Member Functions inherited from SolverBase< VectorType >
 SolverBase (SolverControl &solver_control, VectorMemory< VectorType > &vector_memory)
 
 SolverBase (SolverControl &solver_control)
 
boost::signals2::connection connect (const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const VectorType &current_iterate)> &slot)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Public Types inherited from SolverBase< VectorType >
using vector_type = VectorType
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- Protected Attributes inherited from SolverBase< 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 SolverRelaxation< VectorType >

Implementation of an iterative solver based on relaxation methods. The stopping criterion is the norm of the residual.

For the requirements on matrices and vectors in order to work with this class, see the documentation of the Solver base class.

Like all other solver classes, this class has a local structure called AdditionalData which is used to pass additional parameters to the solver, like damping parameters or the number of temporary vectors. We use this additional structure instead of passing these values directly to the constructor because this makes the use of the SolverSelector and other classes much easier and guarantees that these will continue to work even if number or type of the additional parameters for a certain solver changes. AdditionalData of this class currently does not contain any data.

Observing the progress of linear solver iterations

The solve() function of this class uses the mechanism described in the Solver base class to determine convergence. This mechanism can also be used to observe the progress of the iteration.

Author
Guido Kanschat
Date
2010

Definition at line 59 of file solver_relaxation.h.

Constructor & Destructor Documentation

◆ SolverRelaxation()

template<class VectorType >
SolverRelaxation< VectorType >::SolverRelaxation ( SolverControl cn,
const AdditionalData data = AdditionalData() 
)

Constructor.

Definition at line 96 of file solver_relaxation.h.

◆ ~SolverRelaxation()

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

Virtual destructor.

Definition at line 104 of file solver_relaxation.h.

Member Function Documentation

◆ solve()

template<class VectorType >
template<typename MatrixType , class RelaxationType >
void SolverRelaxation< VectorType >::solve ( const MatrixType &  A,
VectorType &  x,
const VectorType &  b,
const RelaxationType &  R 
)

Solve the system \(Ax = b\) using the relaxation method \(x_{k+1} = R(x_k,b)\). The matrix A itself is only used to compute the residual.

Definition at line 111 of file solver_relaxation.h.


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