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

CHROMA

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

#include <syssolver_mdagm_bicgstab.h>

Inheritance diagram for Chroma::MdagMSysSolverBiCGStab< T >:

Public Member Functions
	MdagMSysSolverBiCGStab (Handle< LinearOperator< T > > A_, const SysSolverBiCGStabParams &invParam_)
	Constructor. More...

	~MdagMSysSolverBiCGStab ()
	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
	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
	MdagMSysSolverBiCGStab ()

Private Attributes
Handle< LinearOperator< T > >	A

SysSolverBiCGStabParams	invParam

Detailed Description

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

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

Definition at line 38 of file syssolver_mdagm_bicgstab.h.

Constructor & Destructor Documentation

◆ MdagMSysSolverBiCGStab() [1/2]

template<typename T >

Chroma::MdagMSysSolverBiCGStab< T >::MdagMSysSolverBiCGStab	(	Handle< LinearOperator< T > >	A_,
		const SysSolverBiCGStabParams &	invParam_
	)

inline

Constructor.

Parameters

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

Definition at line 46 of file syssolver_mdagm_bicgstab.h.

◆ ~MdagMSysSolverBiCGStab()

template<typename T >

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

inline

Destructor is automatic.

Definition at line 52 of file syssolver_mdagm_bicgstab.h.

◆ MdagMSysSolverBiCGStab() [2/2]

template<typename T >

Chroma::MdagMSysSolverBiCGStab< T >::MdagMSysSolverBiCGStab ( )

inlineprivate

Definition at line 207 of file syssolver_mdagm_bicgstab.h.

Member Function Documentation

◆ operator()() [1/2]

template<typename T >

SystemSolverResults_t Chroma::MdagMSysSolverBiCGStab< 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::MdagMSystemSolver< T >.

Definition at line 63 of file syssolver_mdagm_bicgstab.h.

References Chroma::MdagMSysSolverBiCGStab< T >::A, Chroma::chi(), Chroma::END_CODE(), Chroma::InvBiCGStab(), Chroma::InvCG2(), Chroma::MdagMSysSolverBiCGStab< T >::invParam, Chroma::SysSolverBiCGStabParams::MaxBiCGStab, MdagM, Chroma::MINUS, Chroma::SystemSolverResults_t::n_count, Chroma::PLUS, Chroma::psi, Chroma::SystemSolverResults_t::resid, Chroma::SysSolverBiCGStabParams::RsdBiCGStab, Chroma::START_CODE(), and Chroma::zero.

◆ operator()() [2/2]

template<typename T >

SystemSolverResults_t Chroma::MdagMSysSolverBiCGStab< T >::operator()	(	T &	psi,
		const T &	chi,
		AbsChronologicalPredictor4D< T > &	predictor
	)		const

inlinevirtual

Solver the linear system.

Parameters

psi	solution ( Modify )
chi	source ( Read )

Returns: syssolver results

Implements Chroma::MdagMSystemSolver< T >.

Definition at line 119 of file syssolver_mdagm_bicgstab.h.

References Chroma::MdagMSysSolverBiCGStab< T >::A, Chroma::chi(), Chroma::END_CODE(), Chroma::InvBiCGStab(), Chroma::InvCG2(), Chroma::MdagMSysSolverBiCGStab< T >::invParam, Chroma::SysSolverBiCGStabParams::MaxBiCGStab, MdagM, Chroma::MINUS, Chroma::SystemSolverResults_t::n_count, Chroma::AbsChronologicalPredictor4D< T >::newVector(), Chroma::AbsTwoStepChronologicalPredictor4D< T >::newXVector(), Chroma::AbsTwoStepChronologicalPredictor4D< T >::newYVector(), Chroma::PLUS, Chroma::AbsTwoStepChronologicalPredictor4D< T >::predictX(), Chroma::AbsTwoStepChronologicalPredictor4D< T >::predictY(), Chroma::psi, Chroma::SystemSolverResults_t::resid, Chroma::SysSolverBiCGStabParams::RsdBiCGStab, Chroma::START_CODE(), and Chroma::zero.

◆ subset()

template<typename T >

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

inlinevirtual

Return the subset on which the operator acts.

Implements Chroma::MdagMSystemSolver< T >.

Definition at line 55 of file syssolver_mdagm_bicgstab.h.

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

Member Data Documentation

◆ A

template<typename T >

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

private

Definition at line 209 of file syssolver_mdagm_bicgstab.h.

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

◆ invParam

template<typename T >

SysSolverBiCGStabParams Chroma::MdagMSysSolverBiCGStab< T >::invParam

private

Definition at line 210 of file syssolver_mdagm_bicgstab.h.

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

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

syssolver_mdagm_bicgstab.h