Grid 0.7.0
Grid::MinimalResidual< Field > Class Template Reference

#include <MinimalResidual.h>

Inheritance diagram for Grid::MinimalResidual< Field >:
OperatorFunction< Field >

Public Member Functions

 MinimalResidual (RealD tol, Integer maxit, Real ovrelparam=1.0, 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
RealD overRelaxParam
Integer IterationsToComplete

Detailed Description

template<class Field>
class Grid::MinimalResidual< Field >

Definition at line 34 of file MinimalResidual.h.

Constructor & Destructor Documentation

◆ MinimalResidual()

template<class Field>
Grid::MinimalResidual< Field >::MinimalResidual ( RealD tol,
Integer maxit,
Real ovrelparam = 1.0,
bool err_on_no_conv = true )
inline

Definition at line 46 of file MinimalResidual.h.

References ErrorOnNoConverge, MaxIterations, overRelaxParam, and Tolerance.

Member Function Documentation

◆ operator()() [1/2]

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

Implements OperatorFunction< Field >.

Definition at line 49 of file MinimalResidual.h.

References conformable(), GridStopWatch::Elapsed(), ErrorOnNoConverge, GridLogDebug, GridLogIterative, GridLogMessage, innerProduct(), IterationsToComplete, MaxIterations, norm2(), LinearOperatorBase< Field >::Op(), overRelaxParam, 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 Grid::MinimalResidual< Field >::ErrorOnNoConverge

Definition at line 38 of file MinimalResidual.h.

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

◆ Tolerance

template<class Field>
RealD Grid::MinimalResidual< Field >::Tolerance

Definition at line 40 of file MinimalResidual.h.

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

◆ MaxIterations

template<class Field>
Integer Grid::MinimalResidual< Field >::MaxIterations

Definition at line 41 of file MinimalResidual.h.

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

◆ overRelaxParam

template<class Field>
RealD Grid::MinimalResidual< Field >::overRelaxParam

Definition at line 42 of file MinimalResidual.h.

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

◆ IterationsToComplete

template<class Field>
Integer Grid::MinimalResidual< Field >::IterationsToComplete

Definition at line 43 of file MinimalResidual.h.

Referenced by operator()().

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