Reference documentation for deal.II version GIT f3cf314fd8 2023-02-08 12:00:02+00:00

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

## Public Member Functions

AdditionalData (const double omega=1, const double min_diagonal=0, const unsigned int n_sweeps=1)

## Public Attributes

double omega

double min_diagonal

unsigned int n_sweeps

## 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.

Definition at line 278 of file trilinos_precondition.h.

## Constructor & Destructor Documentation

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

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

Definition at line 89 of file trilinos_precondition.cc.

## ◆ omega

This specifies the relaxation parameter in the Jacobi preconditioner.

Definition at line 291 of file trilinos_precondition.h.

## ◆ min_diagonal

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.

Definition at line 300 of file trilinos_precondition.h.

## ◆ n_sweeps

Sets how many times the given operation should be applied during the vmult() operation.

Definition at line 306 of file trilinos_precondition.h.

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