TrilinosWrappers::PreconditionJacobi::AdditionalData Struct Reference

#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 285 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 101 of file trilinos_precondition.cc.

Member Data Documentation

double TrilinosWrappers::PreconditionJacobi::AdditionalData::omega

This specifies the relaxation parameter in the Jacobi preconditioner.

Definition at line 298 of file trilinos_precondition.h.

double TrilinosWrappers::PreconditionJacobi::AdditionalData::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 307 of file trilinos_precondition.h.

unsigned int TrilinosWrappers::PreconditionJacobi::AdditionalData::n_sweeps

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

Definition at line 313 of file trilinos_precondition.h.

---

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

• deal.II/lac/trilinos_precondition.h
• /mnt/data/darndt/Sources/dealii-clang-6.0.0/source/lac/trilinos_precondition.cc