CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Chroma::MinimalResidualExtrapolation4DChronoPredictor< T > Class Template Reference
Chroma Lattice Field Theory library » Gauge field update routines » Molecular dynamics support » HMC linear system solver initial guess

Minimal residual predictor. More...

#include <mre_extrap_predictor.h>

Inheritance diagram for Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >:
Chroma::AbsTwoStepChronologicalPredictor4D< T > Chroma::AbsChronologicalPredictor4D< T >

Public Member Functions

 MinimalResidualExtrapolation4DChronoPredictor (unsigned int max_chrono)
 
void reset (void)
 
 ~MinimalResidualExtrapolation4DChronoPredictor (void)
 
void predictX (T &X, const T &chi, const Subset &s) const override
 
void predictY (T &Y, const T &chi, const Subset &s) const override
 
void predictX (T &X, const LinearOperator< T > &M, const T &chi)
 
void predictY (T &Y, const LinearOperator< T > &M, const T &chi)
 
void checkOrthoNormal (const CircularBuffer< T > &buffer, const Subset &s) const
 
void orthonormPrevious (const CircularBuffer< T > &buffer, T &x, const Subset &s) const
 
void newXVector (const T &X_in, const LinearOperator< T > &M) override
 
void newXVector (const T &X)
 
void newYVector (const T &Y)
 
void newYVector (const T &Y_in, const LinearOperator< T > &M) override
 
void replaceXHead (const T &v)
 
void replaceYHead (const T &v)
 
- Public Member Functions inherited from Chroma::AbsTwoStepChronologicalPredictor4D< T >
virtual ~AbsTwoStepChronologicalPredictor4D (void)
 
virtual void operator() (T &psi, const LinearOperator< T > &A, const T &chi)
 
virtual void newVector (const T &psi)
 
- Public Member Functions inherited from Chroma::AbsChronologicalPredictor4D< T >
virtual ~AbsChronologicalPredictor4D (void)
 

Private Member Functions

void find_extrap_solutionM (T &psi, const T &chi, const CircularBuffer< T > &chrono_buf, const CircularBuffer< T > &chrono_bufM, const Subset &s) const
 
void find_extrap_solution (T &psi, const LinearOperator< T > &M, const T &chi, const Handle< CircularBuffer< T > > &chrono_buf, enum PlusMinus isign)
 

Private Attributes

Handle< CircularBuffer< T > > chrono_bufX
 
Handle< CircularBuffer< T > > chrono_bufMX
 
Handle< CircularBuffer< T > > chrono_bufY
 
Handle< CircularBuffer< T > > chrono_bufMY
 

Detailed Description

template<typename T>
class Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >

Minimal residual predictor.

Definition at line 32 of file mre_extrap_predictor.h.

Constructor & Destructor Documentation

◆ MinimalResidualExtrapolation4DChronoPredictor()

template<typename T >
Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::MinimalResidualExtrapolation4DChronoPredictor ( unsigned int  max_chrono)
inline

Definition at line 245 of file mre_extrap_predictor.h.

◆ ~MinimalResidualExtrapolation4DChronoPredictor()

template<typename T >
Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::~MinimalResidualExtrapolation4DChronoPredictor ( void  )
inline

Definition at line 260 of file mre_extrap_predictor.h.

Member Function Documentation

◆ checkOrthoNormal()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::checkOrthoNormal ( const CircularBuffer< T > &  buffer,
const Subset &  s 
) const
inline

Definition at line 420 of file mre_extrap_predictor.h.

References Chroma::i, Chroma::InlinePropAndMatElemDistillation2Env::local::innerProduct(), j, Chroma::s(), and Chroma::CircularBuffer< T >::size().

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector().

◆ find_extrap_solution()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solution ( T &  psi,
const LinearOperator< T > &  M,
const T &  chi,
const Handle< CircularBuffer< T > > &  chrono_buf,
enum PlusMinus  isign 
)
inlineprivate

Definition at line 107 of file mre_extrap_predictor.h.

References Chroma::a, Chroma::b, Chroma::chi(), Chroma::END_CODE(), Chroma::GramSchm(), Chroma::i, Chroma::InlinePropAndMatElemDistillation2Env::local::innerProduct(), Chroma::isign, j, Chroma::LUSolve(), m, n, norm, Chroma::psi, Chroma::r, Chroma::s(), Chroma::START_CODE(), Chroma::LinearOperator< T >::subset(), Chroma::tmp, and Chroma::zero.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY().

◆ find_extrap_solutionM()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solutionM ( T &  psi,
const T &  chi,
const CircularBuffer< T > &  chrono_buf,
const CircularBuffer< T > &  chrono_bufM,
const Subset &  s 
) const
inlineprivate

Definition at line 43 of file mre_extrap_predictor.h.

References Chroma::a, Chroma::b, Chroma::chi(), Chroma::END_CODE(), Chroma::i, Chroma::InlinePropAndMatElemDistillation2Env::local::innerProduct(), j, Chroma::LUSolve(), m, n, Chroma::psi, Chroma::r, Chroma::s(), Chroma::CircularBuffer< T >::size(), and Chroma::START_CODE().

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY().

◆ newXVector() [1/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector ( const T &  X)
inlinevirtual

Implements Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 517 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX, Chroma::END_CODE(), and Chroma::START_CODE().

◆ newXVector() [2/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector ( const T &  X_in,
const LinearOperator< T > &  M 
)
inlineoverridevirtual

Reimplemented from Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 483 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::checkOrthoNormal(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMX, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX, Chroma::END_CODE(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::orthonormPrevious(), Chroma::PLUS, Chroma::START_CODE(), Chroma::LinearOperator< T >::subset(), and Chroma::zero.

◆ newYVector() [1/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector ( const T &  Y)
inlinevirtual

Implements Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 532 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY, Chroma::END_CODE(), and Chroma::START_CODE().

◆ newYVector() [2/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector ( const T &  Y_in,
const LinearOperator< T > &  M 
)
inlineoverridevirtual

Reimplemented from Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 543 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::checkOrthoNormal(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMY, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY, Chroma::END_CODE(), Chroma::MINUS, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::orthonormPrevious(), Chroma::START_CODE(), Chroma::LinearOperator< T >::subset(), and Chroma::zero.

◆ orthonormPrevious()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::orthonormPrevious ( const CircularBuffer< T > &  buffer,
T &  x,
const Subset &  s 
) const
inline

Definition at line 453 of file mre_extrap_predictor.h.

References Chroma::i, Chroma::InlinePropAndMatElemDistillation2Env::local::innerProduct(), Chroma::s(), Chroma::CircularBuffer< T >::size(), and x.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector().

◆ predictX() [1/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX ( T &  X,
const LinearOperator< T > &  M,
const T &  chi 
)
inlinevirtual

Implements Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 340 of file mre_extrap_predictor.h.

References Chroma::chi(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX, Chroma::END_CODE(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solution(), Chroma::PLUS, Chroma::START_CODE(), and Chroma::zero.

◆ predictX() [2/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX ( T &  X,
const T &  chi,
const Subset &  s 
) const
inlineoverridevirtual

Reimplemented from Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 264 of file mre_extrap_predictor.h.

References Chroma::chi(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMX, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX, Chroma::END_CODE(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solutionM(), Chroma::s(), Chroma::START_CODE(), and Chroma::zero.

◆ predictY() [1/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY ( T &  Y,
const LinearOperator< T > &  M,
const T &  chi 
)
inlinevirtual

Implements Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 380 of file mre_extrap_predictor.h.

References Chroma::chi(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY, Chroma::END_CODE(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solution(), Chroma::MINUS, Chroma::START_CODE(), and Chroma::zero.

◆ predictY() [2/2]

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY ( T &  Y,
const T &  chi,
const Subset &  s 
) const
inlineoverridevirtual

Reimplemented from Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 302 of file mre_extrap_predictor.h.

References Chroma::chi(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMY, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY, Chroma::END_CODE(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::find_extrap_solutionM(), Chroma::s(), Chroma::START_CODE(), and Chroma::zero.

◆ replaceXHead()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::replaceXHead ( const T &  v)
inline

Definition at line 573 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX.

◆ replaceYHead()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::replaceYHead ( const T &  v)
inline

Definition at line 578 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY.

◆ reset()

template<typename T >
void Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::reset ( void  )
inlinevirtual

Implements Chroma::AbsTwoStepChronologicalPredictor4D< T >.

Definition at line 252 of file mre_extrap_predictor.h.

References Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMX, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMY, Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX, and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY.

Member Data Documentation

◆ chrono_bufMX

template<typename T >
Handle< CircularBuffer<T> > Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMX
private

Definition at line 37 of file mre_extrap_predictor.h.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::reset().

◆ chrono_bufMY

template<typename T >
Handle< CircularBuffer<T> > Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufMY
private

Definition at line 40 of file mre_extrap_predictor.h.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::reset().

◆ chrono_bufX

template<typename T >
Handle< CircularBuffer<T> > Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufX
private

Definition at line 36 of file mre_extrap_predictor.h.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newXVector(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictX(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::replaceXHead(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::reset().

◆ chrono_bufY

template<typename T >
Handle< CircularBuffer<T> > Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::chrono_bufY
private

Definition at line 39 of file mre_extrap_predictor.h.

Referenced by Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::newYVector(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::predictY(), Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::replaceYHead(), and Chroma::MinimalResidualExtrapolation4DChronoPredictor< T >::reset().

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1