Reference documentation for deal.II version Git 27fb7ec 2016-07-13 12:46:58 -0400
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

typedef MatrixType::size_type size_type
 
typedef PreconditionRelaxation< MatrixType > BaseClass
 
- Public Types inherited from PreconditionRelaxation< MatrixType >
typedef MatrixType::size_type 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 &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () 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::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *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 (A, .6);
solver.solve (A, x, b, precondition);
Author
Guido Kanschat, 2000

Definition at line 610 of file precondition.h.

Member Typedef Documentation

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

Declare type for container size.

Definition at line 616 of file precondition.h.

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

A typedef to the base class.

Definition at line 621 of file precondition.h.

Member Function Documentation

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.

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

Apply preconditioner.

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().

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

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

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 663 of file precondition.h.


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