Reference documentation for deal.II version 9.1.1
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Types | Public Member Functions | Private Attributes | List of all members

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

Inheritance diagram for PreconditionPSOR< MatrixType >:
[legend]

Classes

class  AdditionalData
 

Public Types

using size_type = typename MatrixType::size_type
 
- Public Types inherited from PreconditionRelaxation< MatrixType >
using size_type = typename MatrixType::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< MatrixType >
void initialize (const MatrixType &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 ()
 
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)
 

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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
- Protected Attributes inherited from PreconditionRelaxation< MatrixType >
SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > 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
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
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 765 of file precondition.h.

Member Typedef Documentation

◆ size_type

template<typename MatrixType = SparseMatrix<double>>
using PreconditionPSOR< MatrixType >::size_type = typename MatrixType::size_type

Declare type for container size.

Definition at line 771 of file precondition.h.

Member Function Documentation

◆ initialize() [1/2]

template<typename MatrixType = SparseMatrix<double>>
void PreconditionPSOR< MatrixType >::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() 
)

Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object.

The permutation vector is stored as a pointer. Therefore, it has to be assured that the lifetime of the vector exceeds the lifetime of the preconditioner.

The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.

◆ initialize() [2/2]

template<typename MatrixType = SparseMatrix<double>>
void PreconditionPSOR< MatrixType >::initialize ( const MatrixType &  A,
const AdditionalData additional_data 
)

Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object.

For more detail about possible parameters, see the class documentation and the documentation of the PreconditionPSOR::AdditionalData class.

After this function is called the preconditioner is ready to be used (using the vmult function of derived classes).

◆ vmult()

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionPSOR< MatrixType >::vmult ( VectorType &  ,
const VectorType &   
) const

Apply preconditioner.

◆ Tvmult()

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionPSOR< MatrixType >::Tvmult ( VectorType &  ,
const VectorType &   
) const

Apply transpose preconditioner.

Member Data Documentation

◆ permutation

template<typename MatrixType = SparseMatrix<double>>
const std::vector<size_type>* PreconditionPSOR< MatrixType >::permutation
private

Storage for the permutation vector.

Definition at line 860 of file precondition.h.

◆ inverse_permutation

template<typename MatrixType = SparseMatrix<double>>
const std::vector<size_type>* PreconditionPSOR< MatrixType >::inverse_permutation
private

Storage for the inverse permutation vector.

Definition at line 864 of file precondition.h.


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