deal.II version GIT relicensing-2017-g7ae82fad8b 2024-10-22 19:20:00+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
SolverCG< VectorType >::AdditionalData Struct Reference

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

Public Member Functions

 AdditionalData (const bool use_default_residual=true)
 

Public Attributes

bool use_default_residual
 

Detailed Description

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

Standardized data struct to pipe additional data to the solver.

Definition at line 208 of file solver_cg.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<typename VectorType = Vector<double>>
SolverCG< VectorType >::AdditionalData::AdditionalData ( const bool  use_default_residual = true)
explicit

Constructor. By default, set the residual of the stopping criterion to the implicit residual. A true value of AdditionalData::use_default_residual refers to the implicit residual, while false reverts it. The former uses the result of the matrix-vector product already computed in other algorithm steps to derive the residual by a mere vector update, whereas the latter explicitly calculates the system residual with an additional matrix-vector product. More information on explicit and implicit residual stopping criteria can be found link here.

Member Data Documentation

◆ use_default_residual

template<typename VectorType = Vector<double>>
bool SolverCG< VectorType >::AdditionalData::use_default_residual

Flag for the default residual that is used to measure convergence.

Definition at line 229 of file solver_cg.h.


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