LinearAlgebra::TpetraWrappers::PreconditionILUT< 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::PreconditionILUT< Number, MemorySpace >::AdditionalData

The set of additional parameters to tune the preconditioner.

Definition at line 1009 of file trilinos_tpetra_precondition.h.

Public Member Functions
	AdditionalData (const double ilut_drop=0., const double ilut_fill=0., const double ilut_atol=0., const double ilut_rtol=1., const int overlap=0)
	Constructor.

Public Attributes
double	ilut_drop
	Threshold for dropping entries.
double	ilut_fill
	Amount of additional fill-in.
double	ilut_atol
	Constant to be added to each diagonal entry before factorization.
double	ilut_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::PreconditionILUT< Number, MemorySpace >::AdditionalData::AdditionalData	(	const double	ilut_drop = 0.,
		const double	ilut_fill = 0.,
		const double	ilut_atol = 0.,
		const double	ilut_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 ilut_atol and

\[\beta\]

given by ilut_rtol.

Parameters

ilut_drop	Threshold for dropping entries.
ilut_fill	Amount of additional fill-in.
ilut_atol	Constant to be to each diagonal entry before factorization.
ilut_rtol	Factor to scale all diagonal entries by before factorization.
overlap	Overlap between processor local matrices.

Member Data Documentation

ilut_drop

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

double LinearAlgebra::TpetraWrappers::PreconditionILUT< Number, MemorySpace >::AdditionalData::ilut_drop

Threshold for dropping entries.

Together with ilut_fill this controls the amount of fill-in and the actual values to be used or dropped.

Definition at line 1037 of file trilinos_tpetra_precondition.h.

ilut_fill

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

double LinearAlgebra::TpetraWrappers::PreconditionILUT< Number, MemorySpace >::AdditionalData::ilut_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. Note, however, that this will drastically increase the memory requirement, especially for 3d simulations.

Definition at line 1047 of file trilinos_tpetra_precondition.h.

ilut_atol

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

double LinearAlgebra::TpetraWrappers::PreconditionILUT< Number, MemorySpace >::AdditionalData::ilut_atol

Constant to be added to each diagonal entry before factorization.

Definition at line 1052 of file trilinos_tpetra_precondition.h.

ilut_rtol

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

double LinearAlgebra::TpetraWrappers::PreconditionILUT< Number, MemorySpace >::AdditionalData::ilut_rtol

Factor to scale all diagonal entries by before factorization.

Definition at line 1057 of file trilinos_tpetra_precondition.h.

overlap

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

int LinearAlgebra::TpetraWrappers::PreconditionILUT< 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 1067 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