Reference documentation for deal.II version Git 74ec1a6c4b 2021-01-19 10:11:04 -0500
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | 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 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
 
void initialize (const MatrixType &A, const AdditionalData &parameters=AdditionalData())
 
void clear ()
 
size_type m () const
 
size_type n () const
 
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 Public Member Functions

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

Protected Attributes

SmartPointer< const MatrixType, PreconditionRelaxation< MatrixType > > A
 
double relaxation
 

Private Attributes

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

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
//...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);

Definition at line 749 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 755 of file precondition.h.

Member Function Documentation

◆ initialize() [1/3]

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/3]

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.

◆ initialize() [3/3]

template<typename MatrixType = SparseMatrix<double>>
void PreconditionRelaxation< MatrixType >::initialize ( const MatrixType &  A,
const AdditionalData parameters = AdditionalData() 
)
inherited

Initialize matrix and relaxation parameter. The matrix is just stored in the preconditioner object. The relaxation parameter should be larger than zero and smaller than 2 for numerical reasons. It defaults to 1.

◆ clear()

template<typename MatrixType = SparseMatrix<double>>
void PreconditionRelaxation< MatrixType >::clear ( )
inherited

Release the matrix and reset its pointer.

◆ m()

template<typename MatrixType = SparseMatrix<double>>
size_type PreconditionRelaxation< MatrixType >::m ( ) const
inherited

Return the dimension of the codomain (or range) space. Note that the matrix is of dimension \(m \times n\).

◆ n()

template<typename MatrixType = SparseMatrix<double>>
size_type PreconditionRelaxation< MatrixType >::n ( ) const
inherited

Return the dimension of the domain space. Note that the matrix is of dimension \(m \times n\).

◆ 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

◆ permutation

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

Storage for the permutation vector.

Definition at line 844 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 848 of file precondition.h.

◆ A

template<typename MatrixType = SparseMatrix<double>>
SmartPointer<const MatrixType, PreconditionRelaxation<MatrixType> > PreconditionRelaxation< MatrixType >::A
protectedinherited

Pointer to the matrix object.

Definition at line 460 of file precondition.h.

◆ relaxation

template<typename MatrixType = SparseMatrix<double>>
double PreconditionRelaxation< MatrixType >::relaxation
protectedinherited

Relaxation parameter.

Definition at line 465 of file precondition.h.


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