SolverMinRes< VectorType > Class Template Reference

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

Inheritance diagram for SolverMinRes< VectorType >:

Classes
struct	AdditionalData

Public Member Functions
	SolverMinRes (SolverControl &cn, VectorMemory< VectorType > &mem, const AdditionalData &data=AdditionalData())
	SolverMinRes (SolverControl &cn, const AdditionalData &data=AdditionalData())
virtual	~SolverMinRes () override=default
template<typename MatrixType , typename PreconditionerType >
void	solve (const MatrixType &A, VectorType &x, const VectorType &b, const PreconditionerType &preconditioner)
Public Member Functions inherited from SolverBase< Vector< double > >
	SolverBase (SolverControl &solver_control, VectorMemory< Vector< double > > &vector_memory)
	SolverBase (SolverControl &solver_control)
boost::signals2::connection	connect (const std::function< SolverControl::State(const unsigned int iteration, const double check_value, const Vector< double > &current_iterate)> &slot)
Public Member Functions inherited from Subscriptor
	Subscriptor ()
	Subscriptor (const Subscriptor &)
	Subscriptor (Subscriptor &&) noexcept
virtual	~Subscriptor ()
Subscriptor &	operator= (const Subscriptor &)
Subscriptor &	operator= (Subscriptor &&) noexcept
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)

Static Public Member Functions
static ::ExceptionBase &	ExcPreconditionerNotDefinite ()
Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)
static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Member Functions
virtual double	criterion ()
virtual void	print_vectors (const unsigned int step, const VectorType &x, const VectorType &r, const VectorType &d) const

Protected Attributes
double	res2
Protected Attributes inherited from SolverBase< Vector< double > >
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

Additional Inherited Members
Public Types inherited from SolverBase< Vector< double > >
using	vector_type = Vector< double >

Detailed Description

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

Minimal residual method for symmetric matrices.

For the requirements on matrices and vectors in order to work with this class, see the documentation of the Solver base class.

Like all other solver classes, this class has a local structure called AdditionalData which is used to pass additional parameters to the solver, like damping parameters or the number of temporary vectors. We use this additional structure instead of passing these values directly to the constructor because this makes the use of the SolverSelector and other classes much easier and guarantees that these will continue to work even if number or type of the additional parameters for a certain solver changes.

However, since the MinRes method does not need additional data, the respective structure is empty and does not offer any functionality. The constructor has a default argument, so you may call it without the additional parameter.

The preconditioner has to be positive definite and symmetric

The algorithm is taken from the Master thesis of Astrid Battermann with some changes. The full text can be found at http://scholar.lib.vt.edu/theses/public/etd-12164379662151/etd-title.html

Observing the progress of linear solver iterations

The solve() function of this class uses the mechanism described in the Solver base class to determine convergence. This mechanism can also be used to observe the progress of the iteration.

Author

Thomas Richter, 2000, Luca Heltai, 2006

Definition at line 72 of file solver_minres.h.

Constructor & Destructor Documentation

SolverMinRes() [1/2]

template<class VectorType = Vector<double>>

SolverMinRes< VectorType >::SolverMinRes	(	SolverControl &	cn,
		VectorMemory< VectorType > &	mem,
		const AdditionalData &	data = AdditionalData()
	)

Constructor.

SolverMinRes() [2/2]

template<class VectorType = Vector<double>>

SolverMinRes< VectorType >::SolverMinRes	(	SolverControl &	cn,
		const AdditionalData &	data = AdditionalData()
	)

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

~SolverMinRes()

template<class VectorType = Vector<double>>

virtual SolverMinRes< VectorType >::~SolverMinRes ( )

overridevirtualdefault

Virtual destructor.

Member Function Documentation

solve()

template<class VectorType = Vector<double>>

template<typename MatrixType , typename PreconditionerType >

void SolverMinRes< VectorType >::solve	(	const MatrixType &	A,
		VectorType &	x,
		const VectorType &	b,
		const PreconditionerType &	preconditioner
	)

Solve the linear system \(Ax=b\) for x.

---

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

• include/deal.II/lac/solver_minres.h