Grid 0.7.0
BiCGSTAB< Field > Class Template Reference

#include <BiCGSTAB.h>

Inheritance diagram for BiCGSTAB< Field >:
OperatorFunction< Field >

Public Member Functions

 BiCGSTAB (RealD tol, Integer maxit, bool err_on_no_conv=true)
void operator() (LinearOperatorBase< Field > &Linop, const Field &src, Field &psi)
virtual void operator() (LinearOperatorBase< Field > &Linop, const std::vector< Field > &in, std::vector< Field > &out)

Data Fields

bool ErrorOnNoConverge
RealD Tolerance
Integer MaxIterations
Integer IterationsToComplete

Detailed Description

template<class Field>
class BiCGSTAB< Field >

Definition at line 45 of file BiCGSTAB.h.

Constructor & Destructor Documentation

◆ BiCGSTAB()

template<class Field>
BiCGSTAB< Field >::BiCGSTAB ( RealD tol,
Integer maxit,
bool err_on_no_conv = true )
inline

Definition at line 56 of file BiCGSTAB.h.

References ErrorOnNoConverge, MaxIterations, and Tolerance.

Member Function Documentation

◆ operator()() [1/2]

template<class Field>
void BiCGSTAB< Field >::operator() ( LinearOperatorBase< Field > & Linop,
const Field & src,
Field & psi )
inlinevirtual

Implements OperatorFunction< Field >.

Definition at line 59 of file BiCGSTAB.h.

References accelerator_for, AcceleratorRead, AcceleratorWrite, autoView, conformable(), GridStopWatch::Elapsed(), ErrorOnNoConverge, GridLogIterative, GridLogMessage, innerProduct(), IterationsToComplete, MaxIterations, norm2(), LinearOperatorBase< Field >::Op(), sqrt(), GridStopWatch::Start(), GridStopWatch::Stop(), and Tolerance.

◆ operator()() [2/2]

template<class Field>
virtual void OperatorFunction< Field >::operator() ( LinearOperatorBase< Field > & Linop,
const std::vector< Field > & in,
std::vector< Field > & out )
inlinevirtualinherited

Reimplemented in BlockConjugateGradient< Field >.

Definition at line 625 of file LinearOperator.h.

Field Documentation

◆ ErrorOnNoConverge

template<class Field>
bool BiCGSTAB< Field >::ErrorOnNoConverge

Definition at line 50 of file BiCGSTAB.h.

Referenced by BiCGSTAB(), operator()(), and MixedPrecisionBiCGSTAB< FieldD, FieldF, type, type >::operator()().

◆ Tolerance

template<class Field>
RealD BiCGSTAB< Field >::Tolerance

Definition at line 52 of file BiCGSTAB.h.

Referenced by BiCGSTAB(), operator()(), and MixedPrecisionBiCGSTAB< FieldD, FieldF, type, type >::operator()().

◆ MaxIterations

template<class Field>
Integer BiCGSTAB< Field >::MaxIterations

Definition at line 53 of file BiCGSTAB.h.

Referenced by BiCGSTAB(), and operator()().

◆ IterationsToComplete

template<class Field>
Integer BiCGSTAB< Field >::IterationsToComplete

Definition at line 54 of file BiCGSTAB.h.

Referenced by operator()(), and MixedPrecisionBiCGSTAB< FieldD, FieldF, type, type >::operator()().

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