Chroma::LinOpSysSolverCG< T > Class Template Reference

Solve a M*psi=chi linear system by CG2. More...

#include <syssolver_linop_cg.h>

Inheritance diagram for Chroma::LinOpSysSolverCG< T >:

Public Member Functions
	LinOpSysSolverCG (Handle< LinearOperator< T > > A_, const SysSolverCGParams &invParam_)
	Constructor. More...
	~LinOpSysSolverCG ()
	Destructor is automatic. More...
const Subset &	subset () const
	Return the subset on which the operator acts. More...
SystemSolverResults_t	operator() (T &psi, const T &chi) const
	Solver the linear system. More...
Public Member Functions inherited from Chroma::SystemSolver< T >
virtual	~SystemSolver ()
	Virtual destructor to help with cleanup;. More...

Private Member Functions
	LinOpSysSolverCG ()

Private Attributes
Handle< LinearOperator< T > >	A
SysSolverCGParams	invParam

Detailed Description

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

Solve a M*psi=chi linear system by CG2.

Definition at line 32 of file syssolver_linop_cg.h.

Constructor & Destructor Documentation

LinOpSysSolverCG() [1/2]

template<typename T >

Chroma::LinOpSysSolverCG< T >::LinOpSysSolverCG ( Handle< LinearOperator< T > >  A_, const SysSolverCGParams &  invParam_  )

inline

Constructor.

Parameters

M_	Linear operator ( Read )
invParam	inverter parameters ( Read )

Definition at line 40 of file syssolver_linop_cg.h.

~LinOpSysSolverCG()

template<typename T >

Chroma::LinOpSysSolverCG< T >::~LinOpSysSolverCG ( )

inline

Destructor is automatic.

Definition at line 46 of file syssolver_linop_cg.h.

LinOpSysSolverCG() [2/2]

template<typename T >

Chroma::LinOpSysSolverCG< T >::LinOpSysSolverCG ( )

inlineprivate

Definition at line 101 of file syssolver_linop_cg.h.

Member Function Documentation

operator()()

template<typename T >

SystemSolverResults_t Chroma::LinOpSysSolverCG< T >::operator() ( T &  psi, const T &  chi  ) const

inlinevirtual

Solver the linear system.

Parameters

psi	solution ( Modify )
chi	source ( Read )

Returns

syssolver results

Implements Chroma::SystemSolver< T >.

Definition at line 57 of file syssolver_linop_cg.h.

References Chroma::LinOpSysSolverCG< T >::A, Chroma::chi(), Chroma::END_CODE(), Chroma::InvCG2(), Chroma::LinOpSysSolverCG< T >::invParam, Chroma::SysSolverCGParams::MaxCG, Chroma::SysSolverCGParams::MaxCGRestart, Chroma::MINUS, Chroma::n_count, Chroma::SystemSolverResults_t::n_count, Chroma::PLUS, Chroma::psi, Chroma::r, Chroma::SystemSolverResults_t::resid, Chroma::SysSolverCGParams::RsdCG, Chroma::SysSolverCGParams::RsdCGRestart, Chroma::START_CODE(), and Chroma::tmp.

subset()

template<typename T >

const Subset& Chroma::LinOpSysSolverCG< T >::subset ( void  ) const

inlinevirtual

Return the subset on which the operator acts.

Implements Chroma::SystemSolver< T >.

Definition at line 49 of file syssolver_linop_cg.h.

References Chroma::LinOpSysSolverCG< T >::A.

Member Data Documentation

A

template<typename T >

Handle< LinearOperator<T> > Chroma::LinOpSysSolverCG< T >::A

private

Definition at line 103 of file syssolver_linop_cg.h.

Referenced by Chroma::LinOpSysSolverCG< T >::operator()(), and Chroma::LinOpSysSolverCG< T >::subset().

invParam

template<typename T >

SysSolverCGParams Chroma::LinOpSysSolverCG< T >::invParam

private

Definition at line 104 of file syssolver_linop_cg.h.

Referenced by Chroma::LinOpSysSolverCG< T >::operator()().

---

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

• syssolver_linop_cg.h