Dune Core Modules (2.4.2)

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

#include <dune/istl/solvers.hh>

Public Types

typedef X domain_type
 The domain type of the operator to be inverted.
 
typedef X range_type
 The range type of the operator to be inverted.
 
typedef X::field_type field_type
 The field type of the operator to be inverted.
 
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)
 

Public Member Functions

template<class L , class P >
 BiCGSTABSolver (L &op, P &prec, real_type reduction, int maxit, int verbose)
 Set up solver. More...
 
template<class L , class S , class P >
 BiCGSTABSolver (L &op, S &sp, P &prec, real_type reduction, int maxit, int verbose)
 Set up solver. More...
 
virtual void apply (X &x, X &b, InverseOperatorResult &res)
 Apply inverse operator. More...
 
virtual void apply (X &x, X &b, double reduction, InverseOperatorResult &res)
 Apply inverse operator with given reduction factor. More...
 

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)

Constructor & Destructor Documentation

◆ BiCGSTABSolver() [1/2]

template<class X >
template<class L , class P >
Dune::BiCGSTABSolver< X >::BiCGSTABSolver ( L &  op,
P &  prec,
real_type  reduction,
int  maxit,
int  verbose 
)
inline

Set up solver.

References Dune::SolverCategory::sequential.

◆ BiCGSTABSolver() [2/2]

template<class X >
template<class L , class S , class P >
Dune::BiCGSTABSolver< X >::BiCGSTABSolver ( L &  op,
S &  sp,
P &  prec,
real_type  reduction,
int  maxit,
int  verbose 
)
inline

Set up solver.

Member Function Documentation

◆ apply() [1/2]

template<class X >
virtual void Dune::BiCGSTABSolver< X >::apply ( X &  x,
X &  b,
double  reduction,
InverseOperatorResult res 
)
inlinevirtual

Apply inverse operator with given reduction factor.

apply inverse operator, with given convergence criteria.

Warning
Right hand side b may be overwritten!
Parameters
xThe left hand side to store the result in.
bThe right hand side
reductionThe minimum defect reduction to achieve.
resObject to store the statistics about applying the operator.

Implements Dune::InverseOperator< X, X >.

◆ apply() [2/2]

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

Apply inverse operator.

Apply inverse operator,.

Warning
Note: right hand side b may be overwritten!
Parameters
xThe left hand side to store the result in.
bThe right hand side
resObject to store the statistics about applying the operator.

Implements Dune::InverseOperator< X, X >.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 18, 22:30, 2024)