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

 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 > ¤t_iterate)> &slot) 

template<class Archive > 
void  serialize (Archive &ar, const unsigned int version) 


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

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 


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

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 matrixvector 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 119 of file solver_idr.h.
◆ vector_type
An alias for the underlying vector type
Definition at line 346 of file solver.h.
◆ map_value_type
◆ map_iterator
◆ SolverIDR() [1/2]
template<class VectorType = Vector<double>>
◆ SolverIDR() [2/2]
template<class VectorType = Vector<double>>
◆ ~SolverIDR()
template<class VectorType = Vector<double>>
◆ 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()
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

slot  A 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.
◆ subscribe()
void Subscriptor::subscribe 
( 
std::atomic< bool > *const 
validity, 


const std::string & 
identifier = "" 

) 
 const 

inherited 
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 136 of file subscriptor.cc.
◆ unsubscribe()
void Subscriptor::unsubscribe 
( 
std::atomic< bool > *const 
validity, 


const std::string & 
identifier = "" 

) 
 const 

inherited 
Unsubscribes a user from the object.
 Note
 The
identifier
and the validity
pointer must be the same as the one supplied to subscribe().
Definition at line 156 of file subscriptor.cc.
◆ n_subscriptions()
unsigned int Subscriptor::n_subscriptions 
( 
 ) 
const 

inlineinherited 
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 300 of file subscriptor.h.
◆ list_subscribers() [1/2]
template<typename StreamType >
void Subscriptor::list_subscribers 
( 
StreamType & 
stream  ) 
const 

inlineinherited 
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
◆ list_subscribers() [2/2]
void Subscriptor::list_subscribers 
( 
 ) 
const 

inherited 
◆ serialize()
template<class Archive >
void Subscriptor::serialize 
( 
Archive & 
ar, 


const unsigned int 
version 

) 
 

inlineinherited 
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 309 of file subscriptor.h.
◆ check_no_subscribers()
void Subscriptor::check_no_subscribers 
( 
 ) 
const 

privatenoexceptinherited 
Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.
 Note
 Since this function is just a consistency check it does nothing in release mode.

If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.
Definition at line 53 of file subscriptor.cc.
◆ additional_data
template<class VectorType = 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 414 of file solver.h.
◆ memory
A reference to an object that provides memory for auxiliary vectors.
Definition at line 419 of file solver.h.
◆ iteration_status
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 470 of file solver.h.
◆ counter
std::atomic<unsigned int> Subscriptor::counter 

mutableprivateinherited 
Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).
The creator (and owner) of an object is counted in the map below if HE manages to supply identification.
We use the mutable
keyword in order to allow subscription to constant objects also.
This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic
class template.
Definition at line 219 of file subscriptor.h.
◆ counter_map
std::map<std::string, unsigned int> Subscriptor::counter_map 

mutableprivateinherited 
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 225 of file subscriptor.h.
◆ validity_pointers
std::vector<std::atomic<bool> *> Subscriptor::validity_pointers 

mutableprivateinherited 
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 241 of file subscriptor.h.
◆ object_info
const std::type_info* Subscriptor::object_info 

mutableprivateinherited 
Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.
Definition at line 249 of file subscriptor.h.
◆ mutex
std::mutex Subscriptor::mutex 

staticprivateinherited 
A mutex used to ensure data consistency when printing out the list of subscribers.
Definition at line 271 of file subscriptor.h.
The documentation for this class was generated from the following file: