Grid 0.7.0
PrecGeneralisedConjugateResidual< Field > Class Template Reference

#include <PrecGeneralisedConjugateResidual.h>

Inheritance diagram for PrecGeneralisedConjugateResidual< Field >:
LinearFunction< Field >

Public Member Functions

void Level (int lv)
 PrecGeneralisedConjugateResidual (RealD tol, Integer maxit, LinearOperatorBase< Field > &_Linop, LinearFunction< Field > &Prec, int _mmax, int _nstep)
void operator() (const Field &src, Field &psi)
RealD GCRnStep (const Field &src, Field &psi, RealD rsq)
virtual void operator() (const std::vector< Field > &in, std::vector< Field > &out)

Data Fields

RealD Tolerance
Integer MaxIterations
int verbose
int mmax
int nstep
int steps
int level
GridStopWatch PrecTimer
GridStopWatch MatTimer
GridStopWatch LinalgTimer
LinearFunction< Field > & Preconditioner
LinearOperatorBase< Field > & Linop

Detailed Description

template<class Field>
class PrecGeneralisedConjugateResidual< Field >

Definition at line 44 of file PrecGeneralisedConjugateResidual.h.

Constructor & Destructor Documentation

◆ PrecGeneralisedConjugateResidual()

template<class Field>
PrecGeneralisedConjugateResidual< Field >::PrecGeneralisedConjugateResidual ( RealD tol,
Integer maxit,
LinearOperatorBase< Field > & _Linop,
LinearFunction< Field > & Prec,
int _mmax,
int _nstep )
inline

Definition at line 63 of file PrecGeneralisedConjugateResidual.h.

References level, Linop, MaxIterations, mmax, nstep, Preconditioner, Tolerance, and verbose.

Member Function Documentation

◆ Level()

template<class Field>
void PrecGeneralisedConjugateResidual< Field >::Level ( int lv)
inline

Definition at line 61 of file PrecGeneralisedConjugateResidual.h.

References level.

◆ operator()() [1/2]

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

Implements LinearFunction< Field >.

Definition at line 75 of file PrecGeneralisedConjugateResidual.h.

References axpy(), GridStopWatch::Elapsed(), GCRLogLevel, GCRnStep(), LinalgTimer, Linop, MatTimer, MaxIterations, mmax, norm2(), nstep, PrecTimer, sqrt(), GridStopWatch::Start(), steps, GridStopWatch::Stop(), and Tolerance.

◆ GCRnStep()

template<class Field>
RealD PrecGeneralisedConjugateResidual< Field >::GCRnStep ( const Field & src,
Field & psi,
RealD rsq )
inline

Definition at line 124 of file PrecGeneralisedConjugateResidual.h.

References axpy(), axpy_norm(), GCRLogLevel, innerProduct(), LinalgTimer, Linop, MatTimer, mmax, norm2(), nstep, Preconditioner, PrecTimer, real(), and steps.

Referenced by operator()().

◆ operator()() [2/2]

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

Definition at line 638 of file LinearOperator.h.

Field Documentation

◆ Tolerance

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

Definition at line 47 of file PrecGeneralisedConjugateResidual.h.

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

◆ MaxIterations

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

Definition at line 48 of file PrecGeneralisedConjugateResidual.h.

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

◆ verbose

template<class Field>
int PrecGeneralisedConjugateResidual< Field >::verbose

Definition at line 49 of file PrecGeneralisedConjugateResidual.h.

Referenced by PrecGeneralisedConjugateResidual().

◆ mmax

template<class Field>
int PrecGeneralisedConjugateResidual< Field >::mmax

Definition at line 50 of file PrecGeneralisedConjugateResidual.h.

Referenced by GCRnStep(), operator()(), and PrecGeneralisedConjugateResidual().

◆ nstep

template<class Field>
int PrecGeneralisedConjugateResidual< Field >::nstep

Definition at line 51 of file PrecGeneralisedConjugateResidual.h.

Referenced by GCRnStep(), operator()(), and PrecGeneralisedConjugateResidual().

◆ steps

template<class Field>
int PrecGeneralisedConjugateResidual< Field >::steps

Definition at line 52 of file PrecGeneralisedConjugateResidual.h.

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

◆ level

template<class Field>
int PrecGeneralisedConjugateResidual< Field >::level

Definition at line 53 of file PrecGeneralisedConjugateResidual.h.

Referenced by Level(), and PrecGeneralisedConjugateResidual().

◆ PrecTimer

template<class Field>
GridStopWatch PrecGeneralisedConjugateResidual< Field >::PrecTimer

Definition at line 54 of file PrecGeneralisedConjugateResidual.h.

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

◆ MatTimer

template<class Field>
GridStopWatch PrecGeneralisedConjugateResidual< Field >::MatTimer

Definition at line 55 of file PrecGeneralisedConjugateResidual.h.

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

◆ LinalgTimer

template<class Field>
GridStopWatch PrecGeneralisedConjugateResidual< Field >::LinalgTimer

Definition at line 56 of file PrecGeneralisedConjugateResidual.h.

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

◆ Preconditioner

template<class Field>
LinearFunction<Field>& PrecGeneralisedConjugateResidual< Field >::Preconditioner

Definition at line 58 of file PrecGeneralisedConjugateResidual.h.

Referenced by GCRnStep(), and PrecGeneralisedConjugateResidual().

◆ Linop

template<class Field>
LinearOperatorBase<Field>& PrecGeneralisedConjugateResidual< Field >::Linop

Definition at line 59 of file PrecGeneralisedConjugateResidual.h.

Referenced by GCRnStep(), operator()(), and PrecGeneralisedConjugateResidual().

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