Reference documentation for deal.II version 9.1.1
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | Private Attributes | List of all members
PreconditionUseMatrix< MatrixType, VectorType > Class Template Reference

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

Inheritance diagram for PreconditionUseMatrix< MatrixType, VectorType >:
[legend]

Public Types

using function_ptr = void(MatrixType::*)(VectorType &, const VectorType &) const
 

Public Member Functions

 PreconditionUseMatrix (const MatrixType &M, const function_ptr method)
 
void vmult (VectorType &dst, const VectorType &src) 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 MatrixType & matrix
 
const function_ptr precondition
 

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)
 

Detailed Description

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
class PreconditionUseMatrix< MatrixType, VectorType >

Preconditioner using a matrix-builtin function. This class forms a preconditioner suitable for the LAC solver classes. Since many preconditioning methods are based on matrix entries, these have to be implemented as member functions of the underlying matrix implementation. This class now is intended to allow easy access to these member functions from LAC solver classes.

It seems that all builtin preconditioners have a relaxation parameter, so please use PreconditionRelaxation for these.

You will usually not want to create a named object of this type, although possible. The most common use is like this:

gmres.solve(
matrix, solution, right_hand_side,
matrix, &SparseMatrix<double>::template precondition_Jacobi<double>));

This creates an unnamed object to be passed as the fourth parameter to the solver function of the SolverGMRES class. It assumes that the SparseMatrix class has a function precondition_Jacobi taking two vectors (source and destination) as parameters (Actually, there is no function like that, the existing function takes a third parameter, denoting the relaxation parameter; this example is therefore only meant to illustrate the general idea).

Note that due to the default template parameters, the above example could be written shorter as follows:

...
gmres.solve(
matrix, solution, right_hand_side,
matrix,&SparseMatrix<double>::template precondition_Jacobi<double>));
Author
Guido Kanschat, Wolfgang Bangerth, 1999

Definition at line 363 of file precondition.h.

Member Typedef Documentation

◆ function_ptr

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
using PreconditionUseMatrix< MatrixType, VectorType >::function_ptr = void (MatrixType::*)(VectorType &, const VectorType &) const

Type of the preconditioning function of the matrix.

Definition at line 370 of file precondition.h.

Constructor & Destructor Documentation

◆ PreconditionUseMatrix()

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
PreconditionUseMatrix< MatrixType, VectorType >::PreconditionUseMatrix ( const MatrixType &  M,
const function_ptr  method 
)

Constructor. This constructor stores a reference to the matrix object for later use and selects a preconditioning method, which must be a member function of that matrix.

Member Function Documentation

◆ vmult()

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
void PreconditionUseMatrix< MatrixType, VectorType >::vmult ( VectorType &  dst,
const VectorType &  src 
) const

Execute preconditioning. Calls the function passed to the constructor of this object with the two arguments given here.

Member Data Documentation

◆ matrix

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
const MatrixType& PreconditionUseMatrix< MatrixType, VectorType >::matrix
private

Pointer to the matrix in use.

Definition at line 390 of file precondition.h.

◆ precondition

template<typename MatrixType = SparseMatrix<double>, class VectorType = Vector<double>>
const function_ptr PreconditionUseMatrix< MatrixType, VectorType >::precondition
private

Pointer to the preconditioning function.

Definition at line 395 of file precondition.h.


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