Reference documentation for deal.II version GIT relicensing-233-g802318d791 2024-03-28 20:20:02+00:00
\(\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
Public Member Functions | Public Attributes | List of all members
PreconditionBlock< MatrixType, inverse_type >::AdditionalData Class Reference

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

Public Member Functions

 AdditionalData (const size_type block_size, const double relaxation=1., const bool invert_diagonal=true, const bool same_diagonal=false)
 

Public Attributes

double relaxation
 
size_type block_size
 
bool invert_diagonal
 
bool same_diagonal
 
PreconditionBlockBase< inverse_type >::Inversion inversion
 
double threshold
 

Detailed Description

template<typename MatrixType, typename inverse_type = typename MatrixType::value_type>
class PreconditionBlock< MatrixType, inverse_type >::AdditionalData

Parameters for block preconditioners.

Definition at line 105 of file precondition_block.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
PreconditionBlock< MatrixType, inverse_type >::AdditionalData::AdditionalData ( const size_type  block_size,
const double  relaxation = 1.,
const bool  invert_diagonal = true,
const bool  same_diagonal = false 
)

Constructor. Block size must be given since there is no reasonable default parameter.

Member Data Documentation

◆ relaxation

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
double PreconditionBlock< MatrixType, inverse_type >::AdditionalData::relaxation

Relaxation parameter.

Definition at line 120 of file precondition_block.h.

◆ block_size

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
size_type PreconditionBlock< MatrixType, inverse_type >::AdditionalData::block_size

Block size.

Definition at line 125 of file precondition_block.h.

◆ invert_diagonal

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
bool PreconditionBlock< MatrixType, inverse_type >::AdditionalData::invert_diagonal

Invert diagonal during initialization.

Definition at line 130 of file precondition_block.h.

◆ same_diagonal

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
bool PreconditionBlock< MatrixType, inverse_type >::AdditionalData::same_diagonal

Assume all diagonal blocks are equal to save memory.

Definition at line 135 of file precondition_block.h.

◆ inversion

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
PreconditionBlockBase<inverse_type>::Inversion PreconditionBlock< MatrixType, inverse_type >::AdditionalData::inversion

Choose the inversion method for the blocks.

Definition at line 139 of file precondition_block.h.

◆ threshold

template<typename MatrixType , typename inverse_type = typename MatrixType::value_type>
double PreconditionBlock< MatrixType, inverse_type >::AdditionalData::threshold

The if inversion is SVD, the threshold below which a singular value will be considered zero and thus not inverted. This parameter is used in the call to LAPACKFullMatrix::compute_inverse_svd().

Definition at line 146 of file precondition_block.h.


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