Dune::BiCGSTABSolver< X > Class Template Reference

Bi-conjugate Gradient Stabilized (BiCG-STAB) More...

#include <dune/istl/solvers.hh>

Public Types
typedef X	domain_type
	Type of the domain of the operator to be inverted.
typedef X	range_type
	Type of the range of the operator to be inverted.
typedef X::field_type	field_type
	The field type of the operator.
typedef FieldTraits< field_type >::real_type	real_type
	The real type of the field type (is the same if using real numbers, but differs for std::complex)
typedef Simd::Scalar< real_type >	scalar_real_type
	scalar type underlying the field_type

Public Member Functions
void	apply (X &x, X &b, InverseOperatorResult &res) override
	Apply inverse operator. More...
void	apply (X &x, X &b, double reduction, InverseOperatorResult &res) override
	Apply inverse operator with given reduction factor. More...
SolverCategory::Category	category () const override
	Category of the solver (see SolverCategory::Category)

Protected Member Functions
void	printHeader (std::ostream &s) const
	helper function for printing header of solver output
void	printOutput (std::ostream &s, const CountType &iter, const DataType &norm, const DataType &norm_old) const
	helper function for printing solver output
void	printOutput (std::ostream &s, const CountType &iter, const DataType &norm) const
	helper function for printing solver output

Detailed Description

template<class X>
class Dune::BiCGSTABSolver< X >

Bi-conjugate Gradient Stabilized (BiCG-STAB)

Member Function Documentation

apply() [1/2]

void Dune::IterativeSolver< X, X >::apply ( X &  x, X &  b, double  reduction, InverseOperatorResult &  res  )

inlineoverridevirtualinherited

Apply inverse operator with given reduction factor.

apply inverse operator, with given convergence criteria.

Warning

Right hand side b may be overwritten!

Parameters

x	The left hand side to store the result in.
b	The right hand side
reduction	The minimum defect reduction to achieve.
res	Object to store the statistics about applying the operator.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

Implements Dune::InverseOperator< X, X >.

Reimplemented in Dune::RestartedGMResSolver< X, X >.

apply() [2/2]

template<class X >

void Dune::BiCGSTABSolver< X >::apply ( X &  x, X &  b, InverseOperatorResult &  res  )

inlineoverridevirtual

Apply inverse operator.

Apply inverse operator,.

Warning

Note: right hand side b may be overwritten!

Parameters

x	The left hand side to store the result in.
b	The right hand side
res	Object to store the statistics about applying the operator.

Exceptions

SolverAbort

When the solver detects a problem and cannot continue

Note

Currently, the BiCGSTABSolver aborts when it detects a breakdown.

Implements Dune::InverseOperator< X, X >.

References Dune::Simd::allTrue(), Dune::Simd::cond(), DUNE_THROW, and Dune::Simd::io().

---

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

• dune/istl/solvers.hh