Reference documentation for deal.II version 9.3.3
\(\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 | Protected Attributes | Private Attributes | List of all members
PreconditionPSOR< MatrixType > Class Template Reference
Linear algebra classes | Linear algebra classes » Matrix classes » Preconditioners and Relaxation Operators

#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 SparseMatrix< double > &A, const AdditionalData &parameters=AdditionalData())
 
void clear ()
 
size_type m () const
 
size_type n () const
 

Protected Attributes

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

Private Attributes

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

Subscriptor functionality

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

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

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
SparseMatrix<double> A;
Vector<double> x;
Vector<double> b;
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
PreconditionPSOR<SparseMatrix<double> > precondition;
precondition.initialize (A, permutation, inverse_permutation, .6);
solver.solve (A, x, b, precondition);
Vector
Definition: vector.h:110
PreconditionPSOR::inverse_permutation
const std::vector< size_type > * inverse_permutation
Definition: precondition.h:848
PreconditionRelaxation< SparseMatrix< double > >::A
SmartPointer< const SparseMatrix< double >, PreconditionRelaxation< SparseMatrix< double > > > A
Definition: precondition.h:460
PreconditionPSOR::permutation
const std::vector< size_type > * permutation
Definition: precondition.h:844
PreconditionPSOR::initialize
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())
Vector::size
size_type size() const
Physics::Elasticity::Kinematics::b
SymmetricTensor< 2, dim, Number > b(const Tensor< 2, dim, Number > &F)

Definition at line 749 of file precondition.h.

Member Function Documentation

◆ initialize()

void PreconditionRelaxation< 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 > >::clear ( )
inherited

Release the matrix and reset its pointer.

◆ m()

size_type PreconditionRelaxation< 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 > >::n ( ) const
inherited

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

Member Data Documentation

◆ A

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

Pointer to the matrix object.

Definition at line 460 of file precondition.h.

◆ relaxation

double PreconditionRelaxation< SparseMatrix< double > >::relaxation
protectedinherited

Relaxation parameter.

Definition at line 465 of file precondition.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4