Reference documentation for deal.II version 9.3.3
\(\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\}}\)
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
SolverIDR< VectorType > Class Template Reference

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

Inheritance diagram for SolverIDR< VectorType >:
[legend]

Classes

struct  AdditionalData
 

Public Types

using vector_type = Vector< double >
 

Public Member Functions

 SolverIDR (SolverControl &cn, VectorMemory< VectorType > &mem, const AdditionalData &data=AdditionalData())
 
 SolverIDR (SolverControl &cn, const AdditionalData &data=AdditionalData())
 
virtual ~SolverIDR () override=default
 
template<typename MatrixType , typename PreconditionerType >
void solve (const MatrixType &A, VectorType &x, const VectorType &b, const PreconditionerType &preconditioner)
 
boost::signals2::connection connect (const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const Vector< double > &current_iterate)> &slot)
 

Protected Member Functions

virtual void print_vectors (const unsigned int step, const VectorType &x, const VectorType &r, const VectorType &d) const
 

Protected Attributes

GrowingVectorMemory< Vector< double > > static_vector_memory
 
VectorMemory< Vector< double > > & memory
 
boost::signals2::signal< SolverControl::State(const unsigned int iteration, const double check_value, const Vector< double > &current_iterate), StateCombiner > iteration_status
 

Private Attributes

AdditionalData additional_data
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

std::atomic< unsigned intcounter
 
std::map< std::string, unsigned intcounter_map
 
std::vector< std::atomic< bool > * > validity_pointers
 
const std::type_info * object_info
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

template<class VectorType = Vector<double>>
class SolverIDR< VectorType >

This class implements the IDR(s) method used for solving nonsymmetric, indefinite linear systems, developed in IDR(s): A Family of Simple and Fast Algorithms for Solving Large Nonsymmetric Systems of Linear Equations by Martin B. van Gijzen and Peter Sonneveld . The implementation here is the preconditioned version from Algorithm 913: An Elegant IDR(s) Variant that Efficiently Exploits Biorthogonality Properties by Martin B. van Gijzen and Peter Sonneveld. The local structure AdditionalData takes the value for the parameter s which can be any integer greater than or equal to 1. For s=1, this method has similar convergence to BiCGStab.

Note
Each iteration of IDR(s) requires s+1 preconditioning steps and matrix-vector products. In this implementation the residual is updated and convergence is checked after each of these inner steps inside the outer iteration. If the user enables the history data, the residual at each of these steps is stored and therefore there will be multiple values per iteration.

Definition at line 116 of file solver_idr.h.

Member Typedef Documentation

◆ vector_type

using SolverBase< Vector< double > >::vector_type = Vector< double >
inherited

An alias for the underlying vector type

Definition at line 347 of file solver.h.

Constructor & Destructor Documentation

◆ SolverIDR() [1/2]

template<class VectorType = Vector<double>>
SolverIDR< VectorType >::SolverIDR ( SolverControl cn,
VectorMemory< VectorType > &  mem,
const AdditionalData data = AdditionalData() 
)

Constructor.

◆ SolverIDR() [2/2]

template<class VectorType = Vector<double>>
SolverIDR< VectorType >::SolverIDR ( SolverControl cn,
const AdditionalData data = AdditionalData() 
)
explicit

Constructor. Use an object of type GrowingVectorMemory as a default to allocate memory.

◆ ~SolverIDR()

template<class VectorType = Vector<double>>
virtual SolverIDR< VectorType >::~SolverIDR ( )
overridevirtualdefault

Virtual destructor.

Member Function Documentation

◆ solve()

template<class VectorType = Vector<double>>
template<typename MatrixType , typename PreconditionerType >
void SolverIDR< VectorType >::solve ( const MatrixType &  A,
VectorType &  x,
const VectorType &  b,
const PreconditionerType &  preconditioner 
)

Solve the linear system Ax=b for x.

◆ print_vectors()

template<class VectorType = Vector<double>>
virtual void SolverIDR< VectorType >::print_vectors ( const unsigned int  step,
const VectorType &  x,
const VectorType &  r,
const VectorType &  d 
) const
protectedvirtual

Interface for derived class. This function gets the current iteration vector, the residual and the update vector in each step. It can be used for graphical output of the convergence history.

◆ connect()

boost::signals2::connection SolverBase< Vector< double > >::connect ( const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const Vector< double > &current_iterate)> &  slot)
inherited

Connect a function object that will be called periodically within iterative solvers. This function is used to attach monitors to iterative solvers, either to determine when convergence has happened, or simply to observe the progress of an iteration. See the documentation of this class for more information.

Parameters
slotA function object specified here will, with each call, receive the number of the current iteration, the value that is used to check for convergence (typically the residual of the current iterate with respect to the linear system to be solved) and the currently best available guess for the current iterate. Note that some solvers do not update the approximate solution in every iteration but only after convergence or failure has been determined (GMRES is an example); in such cases, the vector passed as the last argument to the signal is simply the best approximate at the time the signal is called, but not the vector that will be returned if the signal's return value indicates that the iteration should be terminated. The function object must return a SolverControl::State value that indicates whether the iteration should continue, has failed, or has succeeded. The results of all connected functions will then be combined to determine what should happen with the iteration.
Returns
A connection object that represents the connection from the signal to the function object. It can be used to disconnect the function object again from the signal. See the documentation of the BOOST Signals2 library for more information on connection management.

Member Data Documentation

◆ additional_data

template<class VectorType = Vector<double>>
AdditionalData SolverIDR< VectorType >::additional_data
private

Additional solver parameters.

Definition at line 179 of file solver_idr.h.

◆ static_vector_memory

GrowingVectorMemory<Vector< double > > SolverBase< Vector< double > >::static_vector_memory
mutableprotectedinherited

A static vector memory object to be used whenever no such object has been given to the constructor.

Definition at line 415 of file solver.h.

◆ memory

VectorMemory<Vector< double > >& SolverBase< Vector< double > >::memory
protectedinherited

A reference to an object that provides memory for auxiliary vectors.

Definition at line 420 of file solver.h.

◆ iteration_status

boost::signals2::signal< SolverControl::State(const unsigned int iteration, const double check_value, const Vector< double > & current_iterate), StateCombiner> SolverBase< Vector< double > >::iteration_status
protectedinherited

A signal that iterative solvers can execute at the end of every iteration (or in an otherwise periodic fashion) to find out whether we should continue iterating or not. The signal may call one or more slots that each will make this determination by themselves, and the result over all slots (function calls) will be determined by the StateCombiner object.

The arguments passed to the signal are (i) the number of the current iteration; (ii) the value that is used to determine convergence (oftentimes the residual, but in other cases other quantities may be used as long as they converge to zero as the iterate approaches the solution of the linear system); and (iii) a vector that corresponds to the current best guess for the solution at the point where the signal is called. Note that some solvers do not update the approximate solution in every iteration but only after convergence or failure has been determined (GMRES is an example); in such cases, the vector passed as the last argument to the signal is simply the best approximate at the time the signal is called, but not the vector that will be returned if the signal's return value indicates that the iteration should be terminated.

Definition at line 471 of file solver.h.


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