Grid: Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field > Class Template Reference

Grid 0.7.0

#include <CommunicationAvoidingGeneralisedMinimalResidual.h>

Inheritance diagram for Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >:

Public Member Functions
	CommunicationAvoidingGeneralisedMinimalResidual (RealD tol, Integer maxit, Integer restart_length, bool err_on_no_conv=true)
void	operator() (LinearOperatorBase< Field > &LinOp, const Field &src, Field &psi)
RealD	outerLoopBody (LinearOperatorBase< Field > &LinOp, const Field &src, Field &psi, RealD rsq)
void	arnoldiStep (LinearOperatorBase< Field > &LinOp, std::vector< Field > &v, Field &w, int iter)
void	qrUpdate (int iter)
void	computeSolution (std::vector< Field > const &v, Field &psi, int iter)
virtual void	operator() (LinearOperatorBase< Field > &Linop, const std::vector< Field > &in, std::vector< Field > &out)

Data Fields
bool	ErrorOnNoConverge
RealD	Tolerance
Integer	MaxIterations
Integer	RestartLength
Integer	MaxNumberOfRestarts
Integer	IterationCount
GridStopWatch	MatrixTimer
GridStopWatch	LinalgTimer
GridStopWatch	QrTimer
GridStopWatch	CompSolutionTimer
Eigen::MatrixXcd	H
std::vector< ComplexD >	y
std::vector< ComplexD >	gamma
std::vector< ComplexD >	c
std::vector< ComplexD >	s

Detailed Description

template<class Field>
class Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >

Definition at line 35 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Constructor & Destructor Documentation

◆ CommunicationAvoidingGeneralisedMinimalResidual()

template<class Field>

Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::CommunicationAvoidingGeneralisedMinimalResidual	(	RealD	tol,
		Integer	maxit,
		Integer	restart_length,
		bool	err_on_no_conv = true )

inline

Definition at line 62 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References c, ErrorOnNoConverge, gamma, H, MaxIterations, MaxNumberOfRestarts, RestartLength, s, Tolerance, and y.

Member Function Documentation

◆ operator()() [1/2]

template<class Field>

void Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::operator()	(	LinearOperatorBase< Field > &	LinOp,
		const Field &	src,
		Field &	psi )

inlinevirtual

Implements OperatorFunction< Field >.

Definition at line 77 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References axpy(), CompSolutionTimer, conformable(), GridStopWatch::Elapsed(), ErrorOnNoConverge, GridLogIterative, GridLogMessage, GridLogWarning, IterationCount, LinalgTimer, MatrixTimer, MaxNumberOfRestarts, norm2(), LinearOperatorBase< Field >::Op(), outerLoopBody(), QrTimer, sqrt(), GridStopWatch::Start(), GridStopWatch::Stop(), and Tolerance.

◆ outerLoopBody()

template<class Field>

RealD Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::outerLoopBody	(	LinearOperatorBase< Field > &	LinOp,
		const Field &	src,
		Field &	psi,
		RealD	rsq )

inline

Definition at line 143 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References arnoldiStep(), computeSolution(), gamma, GridLogIterative, IterationCount, LinalgTimer, MatrixTimer, MaxIterations, norm2(), LinearOperatorBase< Field >::Op(), qrUpdate(), RestartLength, and sqrt().

Referenced by operator()().

◆ arnoldiStep()

template<class Field>

void Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::arnoldiStep	(	LinearOperatorBase< Field > &	LinOp,
		std::vector< Field > &	v,
		Field &	w,
		int	iter )

inline

Definition at line 192 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References H, innerProduct(), LinalgTimer, MatrixTimer, norm2(), LinearOperatorBase< Field >::Op(), and sqrt().

Referenced by outerLoopBody().

◆ qrUpdate()

template<class Field>

void Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::qrUpdate ( int iter )

inline

Definition at line 209 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References c, conjugate(), gamma, H, QrTimer, s, and sqrt().

Referenced by outerLoopBody().

◆ computeSolution()

template<class Field>

void Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::computeSolution	(	std::vector< Field > const &	v,
		Field &	psi,
		int	iter )

inline

Definition at line 232 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

References CompSolutionTimer, gamma, H, and y.

Referenced by outerLoopBody().

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

Definition at line 39 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ Tolerance

template<class Field>

RealD Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::Tolerance

Definition at line 42 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ MaxIterations

template<class Field>

Integer Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::MaxIterations

Definition at line 44 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), and outerLoopBody().

◆ RestartLength

template<class Field>

Integer Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::RestartLength

Definition at line 45 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), and outerLoopBody().

◆ MaxNumberOfRestarts

template<class Field>

Integer Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::MaxNumberOfRestarts

Definition at line 46 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ IterationCount

template<class Field>

Integer Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::IterationCount

Definition at line 47 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ MatrixTimer

template<class Field>

GridStopWatch Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::MatrixTimer

Definition at line 50 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by arnoldiStep(), operator()(), and outerLoopBody().

◆ LinalgTimer

template<class Field>

GridStopWatch Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::LinalgTimer

Definition at line 51 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by arnoldiStep(), operator()(), and outerLoopBody().

◆ QrTimer

template<class Field>

GridStopWatch Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::QrTimer

Definition at line 52 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ CompSolutionTimer

template<class Field>

GridStopWatch Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::CompSolutionTimer

Definition at line 53 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

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

◆ H

template<class Field>

Eigen::MatrixXcd Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::H

Definition at line 55 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by arnoldiStep(), CommunicationAvoidingGeneralisedMinimalResidual(), computeSolution(), and qrUpdate().

◆ y

template<class Field>

std::vector<ComplexD> Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::y

Definition at line 57 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), and computeSolution().

◆ gamma

template<class Field>

std::vector<ComplexD> Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::gamma

Definition at line 58 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), computeSolution(), outerLoopBody(), and qrUpdate().

◆ c

template<class Field>

std::vector<ComplexD> Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::c

Definition at line 59 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), and qrUpdate().

◆ s

template<class Field>

std::vector<ComplexD> Grid::CommunicationAvoidingGeneralisedMinimalResidual< Field >::s

Definition at line 60 of file CommunicationAvoidingGeneralisedMinimalResidual.h.

Referenced by CommunicationAvoidingGeneralisedMinimalResidual(), and qrUpdate().

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

Grid/algorithms/iterative/CommunicationAvoidingGeneralisedMinimalResidual.h

Grid
CommunicationAvoidingGeneralisedMinimalResidual
Generated by 1.16.1