CHROMA: Chroma::LinOpSysSolverCGArray< T > Class Template Reference

CHROMA

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

#include <syssolver_linop_cg_array.h>

Inheritance diagram for Chroma::LinOpSysSolverCGArray< T >:

Public Member Functions
	LinOpSysSolverCGArray (Handle< LinearOperatorArray< T > > A_, const SysSolverCGParams &invParam_)
	Constructor. More...

	~LinOpSysSolverCGArray ()
	Destructor is automatic. More...

int	size () const
	Expected length of array index. More...

const Subset &	subset () const
	Return the subset on which the operator acts. More...

SystemSolverResults_t	operator() (multi1d< T > &psi, const multi1d< T > &chi) const
	Solver the linear system. More...

Public Member Functions inherited from Chroma::SystemSolverArray< T >
virtual	~SystemSolverArray ()
	Virtual destructor to help with cleanup;. More...

Private Member Functions
	LinOpSysSolverCGArray ()

Private Attributes
Handle< LinearOperatorArray< T > >	A

SysSolverCGParams	invParam

Detailed Description

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

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

Definition at line 33 of file syssolver_linop_cg_array.h.

Constructor & Destructor Documentation

◆ LinOpSysSolverCGArray() [1/2]

template<typename T >

Chroma::LinOpSysSolverCGArray< T >::LinOpSysSolverCGArray	(	Handle< LinearOperatorArray< T > >	A_,
		const SysSolverCGParams &	invParam_
	)

inline

Constructor.

Parameters

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

Definition at line 41 of file syssolver_linop_cg_array.h.

◆ ~LinOpSysSolverCGArray()

template<typename T >

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

inline

Destructor is automatic.

Definition at line 47 of file syssolver_linop_cg_array.h.

◆ LinOpSysSolverCGArray() [2/2]

template<typename T >

Chroma::LinOpSysSolverCGArray< T >::LinOpSysSolverCGArray ( )

inlineprivate

Definition at line 93 of file syssolver_linop_cg_array.h.

Member Function Documentation

◆ operator()()

template<typename T >

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

inlinevirtual

Solver the linear system.

Parameters

psi	solution ( Modify )
chi	source ( Read )

Returns: syssolver results

Implements Chroma::SystemSolverArray< T >.

Definition at line 61 of file syssolver_linop_cg_array.h.

References Chroma::LinOpSysSolverCGArray< T >::A, Chroma::chi(), Chroma::END_CODE(), Chroma::InvCG2(), Chroma::LinOpSysSolverCGArray< T >::invParam, Chroma::SysSolverCGParams::MaxCG, Chroma::SysSolverCGParams::MaxCGRestart, Chroma::MINUS, Chroma::n_count, Chroma::psi, Chroma::SysSolverCGParams::RsdCG, Chroma::SysSolverCGParams::RsdCGRestart, Chroma::LinOpSysSolverCGArray< T >::size(), and Chroma::START_CODE().

◆ size()

template<typename T >

int Chroma::LinOpSysSolverCGArray< T >::size ( void ) const

inlinevirtual

Expected length of array index.

Implements Chroma::SystemSolverArray< T >.

Definition at line 50 of file syssolver_linop_cg_array.h.

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

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

◆ subset()

template<typename T >

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

inlinevirtual

Return the subset on which the operator acts.

Implements Chroma::SystemSolverArray< T >.

Definition at line 53 of file syssolver_linop_cg_array.h.

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

Member Data Documentation

◆ A

template<typename T >

Handle< LinearOperatorArray<T> > Chroma::LinOpSysSolverCGArray< T >::A

private

Definition at line 95 of file syssolver_linop_cg_array.h.

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

◆ invParam

template<typename T >

SysSolverCGParams Chroma::LinOpSysSolverCGArray< T >::invParam

private

Definition at line 96 of file syssolver_linop_cg_array.h.

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

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

syssolver_linop_cg_array.h