Grid 0.7.0
ConjugateGradient< Field > Class Template Reference

#include <ConjugateGradient.h>

Inheritance diagram for ConjugateGradient< Field >:
OperatorFunction< Field > ConjugateGradientPolynomial< Field >

Public Member Functions

 ConjugateGradient (RealD tol, Integer maxit, bool err_on_no_conv=true)
virtual void LogIteration (int k, RealD a, RealD b)
virtual void LogBegin (void)
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
RealD TrueResidual

Detailed Description

template<class Field>
class ConjugateGradient< Field >

Definition at line 43 of file ConjugateGradient.h.

Constructor & Destructor Documentation

◆ ConjugateGradient()

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

Definition at line 55 of file ConjugateGradient.h.

References ErrorOnNoConverge, MaxIterations, and Tolerance.

Referenced by ConjugateGradientPolynomial< Field >::ConjugateGradientPolynomial().

Member Function Documentation

◆ LogIteration()

template<class Field>
virtual void ConjugateGradient< Field >::LogIteration ( int k,
RealD a,
RealD b )
inlinevirtual

Reimplemented in ConjugateGradientPolynomial< Field >.

Definition at line 61 of file ConjugateGradient.h.

Referenced by operator()().

◆ LogBegin()

template<class Field>
virtual void ConjugateGradient< Field >::LogBegin ( void )
inlinevirtual

Reimplemented in ConjugateGradientPolynomial< Field >.

Definition at line 64 of file ConjugateGradient.h.

Referenced by operator()().

◆ operator()() [1/2]

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

Implements OperatorFunction< Field >.

Definition at line 68 of file ConjugateGradient.h.

References accelerator_for, AcceleratorWrite, autoView, axpy_norm(), conformable(), GridStopWatch::Elapsed(), ErrorOnNoConverge, GRID_TRACE, GridLogDebug, GridLogIterative, GridLogMessage, GridLogPerformance, GridBase::gSites(), LinearOperatorBase< Field >::HermOp(), LinearOperatorBase< Field >::HermOpAndNorm(), innerProduct(), IterationsToComplete, LogBegin(), LogIteration(), MaxIterations, norm2(), sqrt(), GridStopWatch::Start(), GridStopWatch::Stop(), Tolerance, TrueResidual, and usecond().

Referenced by ConjugateGradientPolynomial< Field >::Solve().

◆ 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 ConjugateGradient< Field >::ErrorOnNoConverge

Definition at line 48 of file ConjugateGradient.h.

Referenced by ConjugateGradient(), operator()(), ConjugateGradientReliableUpdate< FieldD, FieldF, type, type >::operator()(), MixedPrecisionConjugateGradient< FieldD, FieldF, type, type >::operator()(), and MixedPrecisionConjugateGradientBatched< FieldD, FieldF, type, type >::operator()().

◆ Tolerance

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

Definition at line 50 of file ConjugateGradient.h.

Referenced by ConjugateGradient(), operator()(), MixedPrecisionConjugateGradient< FieldD, FieldF, type, type >::operator()(), and MixedPrecisionConjugateGradientBatched< FieldD, FieldF, type, type >::operator()().

◆ MaxIterations

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

Definition at line 51 of file ConjugateGradient.h.

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

◆ IterationsToComplete

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

Definition at line 52 of file ConjugateGradient.h.

Referenced by operator()(), ConjugateGradientReliableUpdate< FieldD, FieldF, type, type >::operator()(), MixedPrecisionConjugateGradient< FieldD, FieldF, type, type >::operator()(), and MixedPrecisionConjugateGradientBatched< FieldD, FieldF, type, type >::operator()().

◆ TrueResidual

template<class Field>
RealD ConjugateGradient< Field >::TrueResidual

Definition at line 53 of file ConjugateGradient.h.

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

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