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

CHROMA

Solve a M*psi=chi linear system by biCG with eigenvectors. More...

#include <syssolver_linop_OPTeigbicg.h>

Inheritance diagram for Chroma::LinOpSysSolverOptEigBiCG< T >:

Public Member Functions
void	QIOWriteOptEvecs ()
	Write out an OptEigInfo Type More...

void	QIOReadOptEvecs ()
	Read a OptEigInfo Type More...

	LinOpSysSolverOptEigBiCG (Handle< LinearOperator< T > > A_, const SysSolverOptEigBiCGParams &invParam_)
	Constructor. More...

	~LinOpSysSolverOptEigBiCG ()
	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() (LatticeFermionF &psi, const LatticeFermionF &chi) const

SystemSolverResults_t	operator() (LatticeFermionD &psi, const LatticeFermionD &chi) const

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

Private Member Functions
	LinOpSysSolverOptEigBiCG ()

Private Attributes
int	numMatvecs

Handle< LinearOperator< T > >	A

SysSolverOptEigBiCGParams	invParam

Detailed Description

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

Solve a M*psi=chi linear system by biCG with eigenvectors.

Definition at line 37 of file syssolver_linop_OPTeigbicg.h.

Constructor & Destructor Documentation

◆ LinOpSysSolverOptEigBiCG() [1/2]

template<typename T >

Chroma::LinOpSysSolverOptEigBiCG< T >::LinOpSysSolverOptEigBiCG	(	Handle< LinearOperator< T > >	A_,
		const SysSolverOptEigBiCGParams &	invParam_
	)

inline

Constructor.

Parameters

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

Definition at line 204 of file syssolver_linop_OPTeigbicg.h.

References Chroma::LinOpSysSolverOptEigBiCG< T >::A, Chroma::SysSolverOptEigBiCGParams::eigen_id, Chroma::SysSolverOptEigBiCGParams::file, Chroma::LinAlg::EigInfo::init(), Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::LinOpSysSolverOptEigBiCG< T >::invParam, Chroma::SysSolverOptEigBiCGParams::Neig_max, Chroma::LinOpSysSolverOptEigBiCG< T >::numMatvecs, Chroma::LinOpSysSolverOptEigBiCG< T >::QIOReadOptEvecs(), Chroma::SysSolverOptEigBiCGParams::File_t::read, Chroma::LinAlg::EigInfo::restartTol, and Chroma::SysSolverOptEigBiCGParams::restartTol.

◆ ~LinOpSysSolverOptEigBiCG()

template<typename T >

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

inline

Destructor is automatic.

Definition at line 227 of file syssolver_linop_OPTeigbicg.h.

References Chroma::SysSolverOptEigBiCGParams::cleanUpEvecs, Chroma::SysSolverOptEigBiCGParams::eigen_id, Chroma::SysSolverOptEigBiCGParams::file, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::LinOpSysSolverOptEigBiCG< T >::invParam, Chroma::LinOpSysSolverOptEigBiCG< T >::QIOWriteOptEvecs(), and Chroma::SysSolverOptEigBiCGParams::File_t::write.

◆ LinOpSysSolverOptEigBiCG() [2/2]

template<typename T >

Chroma::LinOpSysSolverOptEigBiCG< T >::LinOpSysSolverOptEigBiCG ( )

inlineprivate

Definition at line 286 of file syssolver_linop_OPTeigbicg.h.

Member Function Documentation

◆ operator()() [1/3]

SystemSolverResults_t Chroma::LinOpSysSolverOptEigBiCG< LatticeFermionD >::operator()	(	LatticeFermionD &	psi,
		const LatticeFermionD &	chi
	)		const

Definition at line 277 of file syssolver_linop_OPTeigbicg.cc.

References Chroma::A(), Chroma::chi(), and Chroma::psi.

◆ operator()() [2/3]

SystemSolverResults_t Chroma::LinOpSysSolverOptEigBiCG< LatticeFermionF >::operator()	(	LatticeFermionF &	psi,
		const LatticeFermionF &	chi
	)		const

Definition at line 269 of file syssolver_linop_OPTeigbicg.cc.

References Chroma::A(), Chroma::chi(), and Chroma::psi.

◆ operator()() [3/3]

template<typename T >

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

virtual

Solver the linear system.

Parameters

psi	solution ( Modify )
chi	source ( Read )

Returns: syssolver results

Definitions supplied in the correspond .cc file

Implements Chroma::SystemSolver< T >.

◆ QIOReadOptEvecs()

template<typename T >

void Chroma::LinOpSysSolverOptEigBiCG< T >::QIOReadOptEvecs ( )

inline

Read a OptEigInfo Type

Definition at line 121 of file syssolver_linop_OPTeigbicg.h.

References Chroma::SysSolverOptEigBiCGParams::eigen_id, Chroma::SysSolverOptEigBiCGParams::file, Chroma::SysSolverOptEigBiCGParams::File_t::file_name, Chroma::i, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::LinOpSysSolverOptEigBiCG< T >::invParam, obj, Chroma::read(), and Chroma::LinOpSysSolverOptEigBiCG< T >::subset().

Referenced by Chroma::LinOpSysSolverOptEigBiCG< T >::LinOpSysSolverOptEigBiCG().

◆ QIOWriteOptEvecs()

template<typename T >

void Chroma::LinOpSysSolverOptEigBiCG< T >::QIOWriteOptEvecs ( )

inline

Write out an OptEigInfo Type

Definition at line 42 of file syssolver_linop_OPTeigbicg.h.

References Chroma::SysSolverOptEigBiCGParams::eigen_id, Chroma::SysSolverOptEigBiCGParams::file, Chroma::SysSolverOptEigBiCGParams::File_t::file_name, Chroma::SysSolverOptEigBiCGParams::File_t::file_volfmt, Chroma::i, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::LinOpSysSolverOptEigBiCG< T >::invParam, obj, Chroma::pop(), Chroma::push(), Chroma::LinOpSysSolverOptEigBiCG< T >::subset(), Chroma::uniqueId(), and Chroma::write().

Referenced by Chroma::LinOpSysSolverOptEigBiCG< T >::~LinOpSysSolverOptEigBiCG().

◆ subset()

template<typename T >

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

inlinevirtual

Return the subset on which the operator acts.

Implements Chroma::SystemSolver< T >.

Definition at line 240 of file syssolver_linop_OPTeigbicg.h.

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

Referenced by Chroma::LinOpSysSolverOptEigBiCG< T >::QIOReadOptEvecs(), and Chroma::LinOpSysSolverOptEigBiCG< T >::QIOWriteOptEvecs().

Member Data Documentation

◆ A

template<typename T >

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

private

Definition at line 288 of file syssolver_linop_OPTeigbicg.h.

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

◆ invParam

template<typename T >

SysSolverOptEigBiCGParams Chroma::LinOpSysSolverOptEigBiCG< T >::invParam

private

Definition at line 289 of file syssolver_linop_OPTeigbicg.h.

Referenced by Chroma::LinOpSysSolverOptEigBiCG< T >::LinOpSysSolverOptEigBiCG(), Chroma::LinOpSysSolverOptEigBiCG< T >::QIOReadOptEvecs(), Chroma::LinOpSysSolverOptEigBiCG< T >::QIOWriteOptEvecs(), and Chroma::LinOpSysSolverOptEigBiCG< T >::~LinOpSysSolverOptEigBiCG().

◆ numMatvecs

template<typename T >

int Chroma::LinOpSysSolverOptEigBiCG< T >::numMatvecs

private

Definition at line 287 of file syssolver_linop_OPTeigbicg.h.

Referenced by Chroma::LinOpSysSolverOptEigBiCG< T >::LinOpSysSolverOptEigBiCG().

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

syssolver_linop_OPTeigbicg.h