Reference documentation for deal.II version GIT relicensing-897-g3473bfcca7 2024-06-24 11:40: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\}}\)
No Matches
Public Member Functions | Public Attributes | List of all members
SolverRichardson< VectorType >::AdditionalData Struct Reference

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

Public Member Functions

 AdditionalData (const double omega=1, const bool use_preconditioned_residual=false)

Public Attributes

double omega
bool use_preconditioned_residual

Detailed Description

template<typename VectorType = Vector<double>>
struct SolverRichardson< VectorType >::AdditionalData

Standardized data struct to pipe additional data to the solver.

Definition at line 71 of file solver_richardson.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename VectorType = Vector<double>>
SolverRichardson< VectorType >::AdditionalData::AdditionalData ( const double  omega = 1,
const bool  use_preconditioned_residual = false 

Constructor. By default, set the damping parameter to one.

Member Data Documentation

◆ omega

template<typename VectorType = Vector<double>>
double SolverRichardson< VectorType >::AdditionalData::omega

Relaxation parameter.

Definition at line 82 of file solver_richardson.h.

◆ use_preconditioned_residual

template<typename VectorType = Vector<double>>
bool SolverRichardson< VectorType >::AdditionalData::use_preconditioned_residual

Parameter for stopping criterion.

Definition at line 87 of file solver_richardson.h.

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