TrilinosWrappers::PreconditionJacobi::AdditionalData Struct Reference

List of all members.

Public Member Functions

 AdditionalData (const double omega=1, const double min_diagonal=0)

Public Attributes

double omega
double min_diagonal


Detailed Description

Standardized data struct to pipe additional flags to the preconditioner. The parameter omega specifies the relaxation parameter in the Jacobi preconditioner. The parameter min_diagonal can be used to make the application of the preconditioner also possible when some diagonal elements are zero. In a default application this would mean that we divide by zero, so by setting the parameter min_diagonal to a small nonzero value the SOR will work on a matrix that is not too far away from the one we want to treat.

Constructor & Destructor Documentation

TrilinosWrappers::PreconditionJacobi::AdditionalData::AdditionalData ( const double  omega = 1,
const double  min_diagonal = 0 
)

Constructor. By default, set the damping parameter to one, and do not modify the diagonal.


Member Data Documentation

This specifies the relaxation parameter in the Jacobi preconditioner.

This specifies the minimum value the diagonal elements should have. This might be necessary when the Jacobi preconditioner is used on matrices with zero diagonal elements. In that case, a straight-forward application would not be possible since we would divide by zero.


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

deal.II documentation generated on Sat Aug 15 16:52:52 2009 by doxygen 1.5.9