Reference documentation for deal.II version 9.4.0
\(\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\}}\)
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
PreconditionSSOR< MatrixType > Class Template Reference

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

Inheritance diagram for PreconditionSSOR< MatrixType >:
[legend]

Public Types

using AdditionalData = typename BaseClass::AdditionalData
 
using size_type = types::global_dof_index
 

Public Member Functions

void initialize (const MatrixType &A, const AdditionalData &parameters=AdditionalData())
 
void initialize (const SparseMatrix< double > &A, const AdditionalData &parameters=AdditionalData())
 
void clear ()
 
size_type m () const
 
size_type n () const
 
void vmult (VectorType &, const VectorType &) const
 
void Tvmult (VectorType &, const VectorType &) const
 
void step (VectorType &x, const VectorType &rhs) const
 
void Tstep (VectorType &x, const VectorType &rhs) const
 

Protected Attributes

SmartPointer< const SparseMatrix< double >, PreconditionRelaxation< SparseMatrix< double > > > A
 
double relaxation
 
unsigned int n_iterations
 
std::shared_ptr< internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > > preconditioner
 

Private Types

using PreconditionerType = internal::PreconditionRelaxation::PreconditionSSORImpl< MatrixType >
 
using BaseClass = PreconditionRelaxation< MatrixType, PreconditionerType >
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
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)
 
std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

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);
Definition: vector.h:109
SmartPointer< const SparseMatrix< double >, PreconditionRelaxation< SparseMatrix< double > > > A
Definition: precondition.h:503
void initialize(const MatrixType &A, const AdditionalData &parameters=AdditionalData())
typename BaseClass::AdditionalData AdditionalData
SymmetricTensor< 2, dim, Number > b(const Tensor< 2, dim, Number > &F)

Definition at line 1254 of file precondition.h.

Member Typedef Documentation

◆ size_type

using PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::size_type = types::global_dof_index
inherited

Declare type for container size.

Definition at line 410 of file precondition.h.

Member Function Documentation

◆ initialize()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::initialize ( const SparseMatrix< double > &  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()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::clear ( )
inherited

Release the matrix and reset its pointer.

◆ m()

size_type PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::m ( ) const
inherited

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

◆ n()

size_type PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::n ( ) const
inherited

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

◆ vmult()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::vmult ( VectorType &  ,
const VectorType &   
) const
inherited

Apply preconditioner.

◆ Tvmult()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::Tvmult ( VectorType &  ,
const VectorType &   
) const
inherited

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

◆ step()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::step ( VectorType &  x,
const VectorType &  rhs 
) const
inherited

Perform one step of the preconditioned Richardson iteration

◆ Tstep()

void PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::Tstep ( VectorType &  x,
const VectorType &  rhs 
) const
inherited

Perform one transposed step of the preconditioned Richardson iteration.

Member Data Documentation

◆ A

SmartPointer<const SparseMatrix< double > , PreconditionRelaxation<SparseMatrix< double > > > PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::A
protectedinherited

Pointer to the matrix object.

Definition at line 503 of file precondition.h.

◆ relaxation

double PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::relaxation
protectedinherited

Relaxation parameter.

Definition at line 508 of file precondition.h.

◆ n_iterations

unsigned int PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::n_iterations
protectedinherited

Number of smoothing steps to be performed.

Definition at line 513 of file precondition.h.

◆ preconditioner

std::shared_ptr<internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > > PreconditionRelaxation< SparseMatrix< double > , internal::PreconditionRelaxation::PreconditionSSORImpl< SparseMatrix< double > > >::preconditioner
protectedinherited

Definition at line 518 of file precondition.h.


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