Reference documentation for deal.II version Git f77fa7e 2014-09-22 17:58:44 +0200
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
PreconditionSSOR< MATRIX > Class Template Reference

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

Inheritance diagram for PreconditionSSOR< MATRIX >:
[legend]

Public Types

typedef types::global_dof_index size_type
 
typedef PreconditionRelaxation
< MATRIX
BaseClass
 

Public Member Functions

void initialize (const MATRIX &A, const typename BaseClass::AdditionalData &parameters=typename BaseClass::AdditionalData())
 
template<class VECTOR >
void vmult (VECTOR &, const VECTOR &) const
 
template<class VECTOR >
void Tvmult (VECTOR &, const VECTOR &) const
 
template<class VECTOR >
void step (VECTOR &x, const VECTOR &rhs) const
 
template<class VECTOR >
void Tstep (VECTOR &x, const VECTOR &rhs) const
 
- Public Member Functions inherited from PreconditionRelaxation< MATRIX >
void initialize (const MATRIX &A, const AdditionalData &parameters=AdditionalData())
 
void clear ()
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
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

- Protected Attributes inherited from PreconditionRelaxation< MATRIX >
SmartPointer< const MATRIX,
PreconditionRelaxation< MATRIX > > 
A
 
double relaxation
 

Detailed Description

template<class MATRIX = SparseMatrix<double>>
class PreconditionSSOR< MATRIX >

SSOR preconditioner using matrix built-in function. The MATRIX class used is required to have a function precondition_SSOR(VECTOR&, const VECTOR&, double)

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

Member Typedef Documentation

template<class MATRIX = SparseMatrix<double>>
typedef types::global_dof_index PreconditionSSOR< MATRIX >::size_type

Declare type for container size.

Definition at line 582 of file precondition.h.

template<class MATRIX = SparseMatrix<double>>
typedef PreconditionRelaxation<MATRIX> PreconditionSSOR< MATRIX >::BaseClass

A typedef to the base class.

Definition at line 587 of file precondition.h.

Member Function Documentation

template<class MATRIX = SparseMatrix<double>>
void PreconditionSSOR< MATRIX >::initialize ( const MATRIX 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<class MATRIX = SparseMatrix<double>>
template<class VECTOR >
void PreconditionSSOR< MATRIX >::vmult ( VECTOR &  ,
const VECTOR &   
) const

Apply preconditioner.

template<class MATRIX = SparseMatrix<double>>
template<class VECTOR >
void PreconditionSSOR< MATRIX >::Tvmult ( VECTOR &  ,
const VECTOR &   
) const

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

template<class MATRIX = SparseMatrix<double>>
template<class VECTOR >
void PreconditionSSOR< MATRIX >::step ( VECTOR &  x,
const VECTOR &  rhs 
) const

Perform one step of the preconditioned Richardson iteration

template<class MATRIX = SparseMatrix<double>>
template<class VECTOR >
void PreconditionSSOR< MATRIX >::Tstep ( VECTOR &  x,
const VECTOR &  rhs 
) const

Perform one transposed step of the preconditioned Richardson iteration.

Member Data Documentation

template<class MATRIX = SparseMatrix<double>>
std::vector<std::size_t> PreconditionSSOR< MATRIX >::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 642 of file precondition.h.


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