CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Chroma::LinOpSysSolverBiCGStab< T > Class Template Reference

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

#include <syssolver_linop_bicgstab.h>

Inheritance diagram for Chroma::LinOpSysSolverBiCGStab< T >:
Chroma::LinOpSystemSolver< T > Chroma::SystemSolver< T >

Public Member Functions

 LinOpSysSolverBiCGStab (Handle< LinearOperator< T > > A_, const SysSolverBiCGStabParams &invParam_)
 Constructor. More...
 
 ~LinOpSysSolverBiCGStab ()
 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

 LinOpSysSolverBiCGStab ()
 

Private Attributes

Handle< LinearOperator< T > > A
 
SysSolverBiCGStabParams invParam
 

Detailed Description

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

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

Definition at line 32 of file syssolver_linop_bicgstab.h.

Constructor & Destructor Documentation

◆ LinOpSysSolverBiCGStab() [1/2]

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

Constructor.

Parameters
A_Linear operator ( Read )
invParaminverter parameters ( Read )

Definition at line 40 of file syssolver_linop_bicgstab.h.

◆ ~LinOpSysSolverBiCGStab()

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

Destructor is automatic.

Definition at line 46 of file syssolver_linop_bicgstab.h.

◆ LinOpSysSolverBiCGStab() [2/2]

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

Definition at line 96 of file syssolver_linop_bicgstab.h.

Member Function Documentation

◆ operator()()

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

◆ subset()

template<typename T >
const Subset& Chroma::LinOpSysSolverBiCGStab< 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_bicgstab.h.

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

Member Data Documentation

◆ A

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

◆ invParam

template<typename T >
SysSolverBiCGStabParams Chroma::LinOpSysSolverBiCGStab< T >::invParam
private

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