Reference documentation for deal.II version Git cd8b20072f 2020-09-24 16:28:23 -0400
\(\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 Member Functions | Public Attributes | List of all members
PreconditionPSOR< MatrixType >::AdditionalData Class Reference

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

Public Member Functions

 AdditionalData (const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation, const typename PreconditionRelaxation< MatrixType >::AdditionalData &parameters=typename PreconditionRelaxation< MatrixType >::AdditionalData())
 

Public Attributes

const std::vector< size_type > & permutation
 
const std::vector< size_type > & inverse_permutation
 
PreconditionRelaxation< MatrixType >::AdditionalData parameters
 

Detailed Description

template<typename MatrixType = SparseMatrix<double>>
class PreconditionPSOR< MatrixType >::AdditionalData

Parameters for PreconditionPSOR.

Definition at line 758 of file precondition.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename MatrixType = SparseMatrix<double>>
PreconditionPSOR< MatrixType >::AdditionalData::AdditionalData ( const std::vector< size_type > &  permutation,
const std::vector< size_type > &  inverse_permutation,
const typename PreconditionRelaxation< MatrixType >::AdditionalData parameters = typename PreconditionRelaxation< MatrixType >::AdditionalData() 
)

Constructor. For the parameters' description, see below.

The permutation vectors are stored as a reference. 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.

Member Data Documentation

◆ permutation

template<typename MatrixType = SparseMatrix<double>>
const std::vector<size_type>& PreconditionPSOR< MatrixType >::AdditionalData::permutation

Storage for the permutation vector.

Definition at line 781 of file precondition.h.

◆ inverse_permutation

template<typename MatrixType = SparseMatrix<double>>
const std::vector<size_type>& PreconditionPSOR< MatrixType >::AdditionalData::inverse_permutation

Storage for the inverse permutation vector.

Definition at line 785 of file precondition.h.

◆ parameters

template<typename MatrixType = SparseMatrix<double>>
PreconditionRelaxation<MatrixType>::AdditionalData PreconditionPSOR< MatrixType >::AdditionalData::parameters

Relaxation parameters

Definition at line 789 of file precondition.h.


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