Reference documentation for deal.II version 8.1.0
Classes | Public Member Functions | List of all members
SolverRelaxation< VECTOR > Class Template Reference

#include <solver_relaxation.h>

Inheritance diagram for SolverRelaxation< VECTOR >:
[legend]

Classes

struct  AdditionalData
 

Public Member Functions

 SolverRelaxation (SolverControl &cn, const AdditionalData &data=AdditionalData())
 
virtual ~SolverRelaxation ()
 
template<class MATRIX , class RELAXATION >
void solve (const MATRIX &A, VECTOR &x, const VECTOR &b, const RELAXATION &R)
 
- Public Member Functions inherited from Solver< VECTOR >
 Solver (SolverControl &solver_control, VectorMemory< VECTOR > &vector_memory)
 
 Solver (SolverControl &solver_control)
 
SolverControlcontrol () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Additional Inherited Members

- Protected Attributes inherited from Solver< VECTOR >
GrowingVectorMemory< VECTOR > static_vector_memory
 
SolverControlcntrl
 
VectorMemory< VECTOR > & memory
 

Detailed Description

template<class VECTOR = Vector<double>>
class SolverRelaxation< VECTOR >

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.

Author
Guido Kanschat
Date
2010

Definition at line 51 of file solver_relaxation.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 91 of file solver_relaxation.h.

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

Virtual destructor.

Definition at line 100 of file solver_relaxation.h.

Member Function Documentation

template<class VECTOR >
template<class MATRIX , class RELAXATION >
void SolverRelaxation< VECTOR >::solve ( const MATRIX A,
VECTOR &  x,
const VECTOR &  b,
const RELAXATION &  R 
)

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

Definition at line 107 of file solver_relaxation.h.


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