Detailed Description

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

The set of additional parameters to tune the preconditioner.

Definition at line 628 of file trilinos_tpetra_precondition.h.

Public Member Functions
	AdditionalData (const double omega=1., const int overlap=0, const bool fix_diagonal=false, const double min_diagonal=0., const int n_sweeps=1)
	Constructor.

Public Attributes
double	omega
	Relaxation damping factor.
int	overlap
	Overlap between processor local matrices.
bool	fix_diagonal
	Whether or not to enlarge entries below a threshold.
double	min_diagonal
	Threshold below which entries will be fixed.
int	n_sweeps
	Set how often the preconditioner should be applied during vmult() or Tvmult().

Constructor & Destructor Documentation

◆ AdditionalData()

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

LinearAlgebra::TpetraWrappers::PreconditionSOR< Number, MemorySpace >::AdditionalData::AdditionalData	(	const double	omega = 1.,
		const int	overlap = 0,
		const bool	fix_diagonal = false,
		const double	min_diagonal = 0.,
		const int	n_sweeps = 1 )

Constructor.

Set the parameters to be used in the preconditioner. The defaults yield a textbook Jacobi preconditioner.

Parameters

omega	The damping factor for the relaxation.
overlap	Overlap between processor local matrices.
fix_diagonal	Fix small diagonal entries for the inversion?
min_diagonal	Threshold for fix_diagonal.
n_sweeps	Number of relaxation sweeps per call to vmult or Tvmult.

Member Data Documentation

◆ omega

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

double LinearAlgebra::TpetraWrappers::PreconditionSOR< Number, MemorySpace >::AdditionalData::omega

Relaxation damping factor.

Definition at line 652 of file trilinos_tpetra_precondition.h.

◆ overlap

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

int LinearAlgebra::TpetraWrappers::PreconditionSOR< 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 662 of file trilinos_tpetra_precondition.h.

◆ fix_diagonal

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

bool LinearAlgebra::TpetraWrappers::PreconditionSOR< Number, MemorySpace >::AdditionalData::fix_diagonal

Whether or not to enlarge entries below a threshold.

If the matrix diagonal contains entries close to zero, their inversion will be close to division by zero. This can be corrected by setting this value to true. This will result in additional computational work during initialization.

Definition at line 671 of file trilinos_tpetra_precondition.h.