PreconditionPSOR< MatrixType >::AdditionalData Class Reference

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

Detailed Description

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

Parameters for PreconditionPSOR.

Definition at line 1844 of file precondition.h.

Public Member Functions
	AdditionalData (const std::vector< size_type > &permutation, const std::vector< size_type > &inverse_permutation, const typename BaseClass::AdditionalData &parameters=typename BaseClass::AdditionalData())

Public Attributes
const std::vector< size_type > &	permutation
const std::vector< size_type > &	inverse_permutation
BaseClass::AdditionalData	parameters

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 BaseClass::AdditionalData &	parameters = typename BaseClass::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 1865 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 1869 of file precondition.h.

parameters

template<typename MatrixType = SparseMatrix<double>>

BaseClass::AdditionalData PreconditionPSOR< MatrixType >::AdditionalData::parameters

Relaxation parameters

Definition at line 1873 of file precondition.h.

---

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

• include/deal.II/lac/precondition.h