Reference documentation for deal.II version Git d4ec8156ca 2019-11-18 14:03:00 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Types | Public Member Functions | Private Attributes | List of all members

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

Inheritance diagram for PreconditionSSOR< MatrixType >:
[legend]

Public Types

using AdditionalData = typename PreconditionRelaxation< MatrixType >::AdditionalData
 
using size_type = typename MatrixType::size_type
 
using BaseClass = PreconditionRelaxation< MatrixType >
 
- Public Types inherited from PreconditionRelaxation< MatrixType >
using size_type = typename MatrixType::size_type
 

Public Member Functions

void initialize (const MatrixType &A, const typename BaseClass::AdditionalData &parameters=typename BaseClass::AdditionalData())
 
template<class VectorType >
void vmult (VectorType &, const VectorType &) const
 
template<class VectorType >
void Tvmult (VectorType &, const VectorType &) const
 
template<class VectorType >
void step (VectorType &x, const VectorType &rhs) const
 
template<class VectorType >
void Tstep (VectorType &x, const VectorType &rhs) 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

std::vector< std::size_t > pos_right_of_diagonal
 

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 PreconditionSSOR< MatrixType >

SSOR preconditioner using matrix built-in function. The MatrixType class used is required to have a function precondition_SSOR(VectorType&, const VectorType&, double). This class satisfies the relaxation concept.

// Declare related objects
SolverCG<> solver(...);
//...initialize and build A
// Define and initialize preconditioner
precondition.initialize(
solver.solve (A, x, b, precondition);
Author
Guido Kanschat, 2000

Definition at line 665 of file precondition.h.

Member Typedef Documentation

◆ AdditionalData

template<typename MatrixType = SparseMatrix<double>>
using PreconditionSSOR< MatrixType >::AdditionalData = typename PreconditionRelaxation<MatrixType>::AdditionalData

An alias to the base class AdditionalData.

Definition at line 672 of file precondition.h.

◆ size_type

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

Declare type for container size.

Definition at line 677 of file precondition.h.

◆ BaseClass

template<typename MatrixType = SparseMatrix<double>>
using PreconditionSSOR< MatrixType >::BaseClass = PreconditionRelaxation<MatrixType>

An alias to the base class.

Definition at line 682 of file precondition.h.

Member Function Documentation

◆ initialize()

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

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.

◆ vmult()

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

Apply preconditioner.

◆ Tvmult()

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

Apply transpose preconditioner. Since this is a symmetric preconditioner, this function is the same as vmult().

◆ step()

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionSSOR< MatrixType >::step ( VectorType &  x,
const VectorType &  rhs 
) const

Perform one step of the preconditioned Richardson iteration

◆ Tstep()

template<typename MatrixType = SparseMatrix<double>>
template<class VectorType >
void PreconditionSSOR< MatrixType >::Tstep ( VectorType &  x,
const VectorType &  rhs 
) const

Perform one transposed step of the preconditioned Richardson iteration.

Member Data Documentation

◆ pos_right_of_diagonal

template<typename MatrixType = SparseMatrix<double>>
std::vector<std::size_t> PreconditionSSOR< MatrixType >::pos_right_of_diagonal
private

An array that stores for each matrix row where the first position after the diagonal is located.

Definition at line 730 of file precondition.h.


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