LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData Struct Reference

The set of additional parameters to tune the preconditioner. More...

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

Detailed Description

template<typename Number, typename MemorySpace = ::MemorySpace::Host>
struct LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData

The set of additional parameters to tune the preconditioner.

Definition at line 925 of file trilinos_tpetra_precondition.h.

Public Member Functions
	AdditionalData (const int ilu_fill=0, const double ilu_atol=0., const double ilu_rtol=1., const int overlap=0)
	Constructor.

Public Attributes
int	ilu_fill
	Amount of additional fill-in.
double	ilu_atol
	Constant to be added to each diagonal entry before factorization.
double	ilu_rtol
	Factor to scale all diagonal entries by before factorization.
int	overlap
	Overlap between processor local matrices.

Constructor & Destructor Documentation

AdditionalData()

template<typename Number, typename MemorySpace = ::MemorySpace::Host>

LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData::AdditionalData	(	const int	ilu_fill = 0,
		const double	ilu_atol = 0.,
		const double	ilu_rtol = 1.,
		const int	overlap = 0 )

Constructor.

Before factorization each diagonal entry will be modified by the following formula

\[a_{ii}^{new} = \alpha\sign(a_{ii})+\beta a_{ii} \]

with

\[\alpha\]

given by ilu_atol and

\[\beta\]

given by ilu_rtol.

Parameters

ilu_fill	Amount of additional fill-in.
ilu_atol	Constant to be to each diagonal entry before factorization.
ilu_rtol	Factor to scale all diagonal entries by before factorization.
overlap	Overlap between processor local matrices.

Member Data Documentation

ilu_fill

template<typename Number, typename MemorySpace = ::MemorySpace::Host>

int LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData::ilu_fill

Amount of additional fill-in.

Level-of-fill to increase the sparsity pattern of the preconditioner. A large enough value will result in a complete LU factorization.

Definition at line 952 of file trilinos_tpetra_precondition.h.

ilu_atol

template<typename Number, typename MemorySpace = ::MemorySpace::Host>

double LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData::ilu_atol

Constant to be added to each diagonal entry before factorization.

Definition at line 957 of file trilinos_tpetra_precondition.h.

ilu_rtol

template<typename Number, typename MemorySpace = ::MemorySpace::Host>

double LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData::ilu_rtol

Factor to scale all diagonal entries by before factorization.

Definition at line 962 of file trilinos_tpetra_precondition.h.

overlap

template<typename Number, typename MemorySpace = ::MemorySpace::Host>

int LinearAlgebra::TpetraWrappers::PreconditionILU< Number, MemorySpace >::AdditionalData::overlap

Overlap between processor local matrices.

The amount of overlap between the processor local matrix blocks used in the underlying additive Schwarz method.

The default will yield a block Jacobi preconditioner with each processor forming its own local block.

Definition at line 972 of file trilinos_tpetra_precondition.h.

---

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

• include/deal.II/lac/trilinos_tpetra_precondition.h