CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members

Solve a CG2 system. Here, the operator is NOT assumed to be hermitian. More...

#include <syssolver_mdagm_cg.h>

Inheritance diagram for Chroma::MdagMSysSolverCG< T >:
Chroma::MdagMSystemSolver< T > Chroma::SystemSolver< T >

Public Member Functions

 MdagMSysSolverCG (Handle< LinearOperator< T > > A_, const SysSolverCGParams &invParam_)
 Constructor. More...
 
 ~MdagMSysSolverCG ()
 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...
 
SystemSolverResults_t operator() (T &psi, const T &chi, AbsChronologicalPredictor4D< T > &predictor) const
 Solve the linear system starting with a chrono guess. More...
 
- Public Member Functions inherited from Chroma::SystemSolver< T >
virtual ~SystemSolver ()
 Virtual destructor to help with cleanup;. More...
 

Private Member Functions

 MdagMSysSolverCG ()
 

Private Attributes

Handle< LinearOperator< T > > A
 
SysSolverCGParams invParam
 

Detailed Description

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

Solve a CG2 system. Here, the operator is NOT assumed to be hermitian.

Definition at line 34 of file syssolver_mdagm_cg.h.

Constructor & Destructor Documentation

◆ MdagMSysSolverCG() [1/2]

template<typename T >
Chroma::MdagMSysSolverCG< T >::MdagMSysSolverCG ( Handle< LinearOperator< T > >  A_,
const SysSolverCGParams invParam_ 
)
inline

Constructor.

Parameters
M_Linear operator ( Read )
invParaminverter parameters ( Read )

Definition at line 42 of file syssolver_mdagm_cg.h.

◆ ~MdagMSysSolverCG()

template<typename T >
Chroma::MdagMSysSolverCG< T >::~MdagMSysSolverCG ( )
inline

Destructor is automatic.

Definition at line 48 of file syssolver_mdagm_cg.h.

◆ MdagMSysSolverCG() [2/2]

template<typename T >
Chroma::MdagMSysSolverCG< T >::MdagMSysSolverCG ( )
inlineprivate

Definition at line 128 of file syssolver_mdagm_cg.h.

Member Function Documentation

◆ operator()() [1/2]

template<typename T >
SystemSolverResults_t Chroma::MdagMSysSolverCG< T >::operator() ( T psi,
const T chi 
) const
inlinevirtual

◆ operator()() [2/2]

template<typename T >
SystemSolverResults_t Chroma::MdagMSysSolverCG< T >::operator() ( T psi,
const T chi,
AbsChronologicalPredictor4D< T > &  predictor 
) const
inlinevirtual

Solve the linear system starting with a chrono guess.

Parameters
psisolution (Write)
chisource (Read)
predictora chronological predictor (Read)
Returns
syssolver results

Implements Chroma::MdagMSystemSolver< T >.

Definition at line 105 of file syssolver_mdagm_cg.h.

References Chroma::MdagMSysSolverCG< T >::A, Chroma::chi(), Chroma::END_CODE(), MdagM, Chroma::AbsChronologicalPredictor4D< T >::newVector(), Chroma::psi, and Chroma::START_CODE().

◆ subset()

template<typename T >
const Subset& Chroma::MdagMSysSolverCG< T >::subset ( void  ) const
inlinevirtual

Return the subset on which the operator acts.

Implements Chroma::MdagMSystemSolver< T >.

Definition at line 51 of file syssolver_mdagm_cg.h.

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

Member Data Documentation

◆ A

template<typename T >
Handle< LinearOperator<T> > Chroma::MdagMSysSolverCG< T >::A
private

◆ invParam

template<typename T >
SysSolverCGParams Chroma::MdagMSysSolverCG< T >::invParam
private

Definition at line 131 of file syssolver_mdagm_cg.h.

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


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