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

The set of additional parameters to tune the preconditioner.

Definition at line 1243 of file trilinos_tpetra_precondition.h.

Public Member Functions
	AdditionalData (const int n_local_parts=1, const double omega=1, const int overlap=1, const int n_sweeps=1)
	Constructor.

Public Attributes
int	n_local_parts
	Number of blocks per processor.
double	omega
	Relaxation damping factor.
int	overlap
	Overlap between processor local matrices.
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::PreconditionBlockSSOR< Number, MemorySpace >::AdditionalData::AdditionalData	(	const int	n_local_parts = 1,
		const double	omega = 1,
		const int	overlap = 1,
		const int	n_sweeps = 1
	)

Constructor.

Set the parameters to be used in the preconditioner.

Parameters

n_local_parts	The number of blocks per processor.
omega	The damping factor for the relaxation.
overlap	Overlap between processors
n_sweeps	Number of relaxation sweeps per call to vmult or Tvmult

Member Data Documentation

n_local_parts

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

int LinearAlgebra::TpetraWrappers::PreconditionBlockSSOR< Number, MemorySpace >::AdditionalData::n_local_parts

Number of blocks per processor.

The default of 1 results in a single block per processor which corresponds to Preconditioner from PreconditionJacobi

Definition at line 1266 of file trilinos_tpetra_precondition.h.

omega

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

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

Relaxation damping factor.

Definition at line 1271 of file trilinos_tpetra_precondition.h.

overlap

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

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

n_sweeps

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

int LinearAlgebra::TpetraWrappers::PreconditionBlockSSOR< Number, MemorySpace >::AdditionalData::n_sweeps

Set how often the preconditioner should be applied during vmult() or Tvmult().

Definition at line 1287 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