deal.II version 9.7.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
LinearAlgebra::TpetraWrappers::PreconditionBlockJacobi< 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::PreconditionBlockJacobi< Number, MemorySpace >::AdditionalData

The set of additional parameters to tune the preconditioner.

Definition at line 1113 of file trilinos_tpetra_precondition.h.

Public Member Functions

 AdditionalData (const int n_local_parts=1, const double omega=1., const int block_overlap=0, const int n_sweeps=1)
 Constructor.

Public Attributes

int n_local_parts
 Number of blocks per processor.
double omega
 Relaxation damping factor.
int block_overlap
 Amount of overlap between blocks.
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::PreconditionBlockJacobi< Number, MemorySpace >::AdditionalData::AdditionalData ( const int n_local_parts = 1,
const double omega = 1.,
const int block_overlap = 0,
const int n_sweeps = 1 )

Constructor.

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

Parameters
n_local_partsThe number of blocks per processor.
omegaThe damping factor for the relaxation.
block_overlapAmount of overlap between blocks
n_sweepsNumber 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::PreconditionBlockJacobi< 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 1137 of file trilinos_tpetra_precondition.h.

◆ omega

template<typename Number, typename MemorySpace = ::MemorySpace::Host>
double LinearAlgebra::TpetraWrappers::PreconditionBlockJacobi< Number, MemorySpace >::AdditionalData::omega

Relaxation damping factor.

Definition at line 1142 of file trilinos_tpetra_precondition.h.

◆ block_overlap

template<typename Number, typename MemorySpace = ::MemorySpace::Host>
int LinearAlgebra::TpetraWrappers::PreconditionBlockJacobi< Number, MemorySpace >::AdditionalData::block_overlap

Amount of overlap between blocks.

Definition at line 1147 of file trilinos_tpetra_precondition.h.

◆ n_sweeps

template<typename Number, typename MemorySpace = ::MemorySpace::Host>
int LinearAlgebra::TpetraWrappers::PreconditionBlockJacobi< Number, MemorySpace >::AdditionalData::n_sweeps

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

Definition at line 1152 of file trilinos_tpetra_precondition.h.


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