PreconditionPSOR< MatrixType > Class Template Reference

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

Inheritance diagram for PreconditionPSOR< MatrixType >:

Classes
class	AdditionalData

Public Types
using	size_type = typename MatrixType::size_type
Public Types inherited from PreconditionRelaxation< SparseMatrix< double > >
using	size_type = typename SparseMatrix< double > ::size_type

Public Member Functions
void	initialize (const MatrixType &A, const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation, const typename PreconditionRelaxation< MatrixType >::AdditionalData &parameters=typename PreconditionRelaxation< MatrixType >::AdditionalData())
void	initialize (const MatrixType &A, const AdditionalData &additional_data)
template<class VectorType >
void	vmult (VectorType &, const VectorType &) const
template<class VectorType >
void	Tvmult (VectorType &, const VectorType &) const
Public Member Functions inherited from PreconditionRelaxation< SparseMatrix< double > >
void	initialize (const SparseMatrix< double > &A, const AdditionalData &parameters=AdditionalData())
void	clear ()
size_type	m () const
size_type	n () const
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
	Subscriptor (Subscriptor &&) noexcept
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
Subscriptor &	operator= (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)

Private Attributes
const std::vector< size_type > *	permutation
const std::vector< size_type > *	inverse_permutation

Additional Inherited Members
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)
Protected Attributes inherited from PreconditionRelaxation< SparseMatrix< double > >
SmartPointer< const SparseMatrix< double >, PreconditionRelaxation< SparseMatrix< double > > >	A
double	relaxation

Detailed Description

template<typename MatrixType = SparseMatrix<double>>
class PreconditionPSOR< MatrixType >

Permuted SOR preconditioner using matrix built-in function. The MatrixType class used is required to have functions PSOR(VectorType&, const VectorType&, double) and TPSOR(VectorType&, const VectorType&, double).

// Declare related objects
 
SparseMatrix<double> A;
Vector<double> x;
Vector<double> b;
SolverCG<> solver(...);
 
//...initialize and build A
 
std::vector<unsigned int> permutation(x.size());
std::vector<unsigned int> inverse_permutation(x.size());
 
//...fill permutation and its inverse with reasonable values
 
// Define and initialize preconditioner
 
PreconditionPSOR<SparseMatrix<double> > precondition;
precondition.initialize (A, permutation, inverse_permutation, .6);
 
solver.solve (A, x, b, precondition);

Author

Guido Kanschat, 2003; extension for full compatibility with LinearOperator class: Jean-Paul Pelteret, 2015

Definition at line 767 of file precondition.h.

---

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

• include/deal.II/lac/precondition.h