Chroma::SysSolverEigCGParams Struct Reference

Params for EigCG inverter. More...

#include <syssolver_eigcg_params.h>

Classes
struct	File_t

Public Member Functions
	SysSolverEigCGParams ()
	Default constructor. More...
	SysSolverEigCGParams (XMLReader &in, const std::string &path)
	Read parameters. More...
void	defaults ()

Public Attributes
std::string	invType
Real	RsdCG
int	MaxCG
int	PrintLevel
int	Neig
int	Nmax
int	esize
int	Neig_max
Real	restartTol
int	updateRestartTol
Real	NormAest
int	vPrecCGvecs
int	vPrecCGvecStart
bool	cleanUpEvecs
std::string	eigen_id
struct Chroma::SysSolverEigCGParams::File_t	file

Detailed Description

Params for EigCG inverter.

Definition at line 17 of file syssolver_eigcg_params.h.

Constructor & Destructor Documentation

SysSolverEigCGParams() [1/2]

Chroma::SysSolverEigCGParams::SysSolverEigCGParams

(

)

Default constructor.

Definition at line 115 of file syssolver_eigcg_params.cc.

References defaults().

SysSolverEigCGParams() [2/2]

Chroma::SysSolverEigCGParams::SysSolverEigCGParams	(	XMLReader &	in,
		const std::string &	path
	)

Read parameters.

Definition at line 121 of file syssolver_eigcg_params.cc.

References Chroma::read().

Member Function Documentation

defaults()

void Chroma::SysSolverEigCGParams::defaults ( )

inline

Definition at line 64 of file syssolver_eigcg_params.h.

References cleanUpEvecs, eigen_id, esize, file, Chroma::SysSolverEigCGParams::File_t::file_name, Chroma::SysSolverEigCGParams::File_t::file_volfmt, MaxCG, Neig, Neig_max, NormAest, PrintLevel, Chroma::SysSolverEigCGParams::File_t::read, restartTol, RsdCG, updateRestartTol, vPrecCGvecs, vPrecCGvecStart, Chroma::SysSolverEigCGParams::File_t::write, and Chroma::zero.

Referenced by Chroma::read(), and SysSolverEigCGParams().

Member Data Documentation

cleanUpEvecs

bool Chroma::SysSolverEigCGParams::cleanUpEvecs

clean up evecs upon destruction of SystemSolver

Definition at line 53 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), Chroma::write(), Chroma::LinOpSysSolverEigCGArray< T >::~LinOpSysSolverEigCGArray(), and Chroma::MdagMSysSolverQDPEigCG< T >::~MdagMSysSolverQDPEigCG().

eigen_id

std::string Chroma::SysSolverEigCGParams::eigen_id

named buffer holding the eigenvectors

Definition at line 54 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::LinOpSysSolverEigCGArray< T >::LinOpSysSolverEigCGArray(), Chroma::MdagMSysSolverQDPEigCG< T >::MdagMSysSolverQDPEigCG(), Chroma::read(), Chroma::write(), Chroma::LinOpSysSolverEigCGArray< T >::~LinOpSysSolverEigCGArray(), and Chroma::MdagMSysSolverQDPEigCG< T >::~MdagMSysSolverQDPEigCG().

esize

int Chroma::SysSolverEigCGParams::esize

2 <= esize <= 2*Neig + 1

Definition at line 29 of file syssolver_eigcg_params.h.

Referenced by defaults(), and Chroma::read().

file

struct Chroma::SysSolverEigCGParams::File_t Chroma::SysSolverEigCGParams::file

Referenced by defaults(), Chroma::read(), and Chroma::write().

invType

std::string Chroma::SysSolverEigCGParams::invType

The type of inverter to use

Definition at line 22 of file syssolver_eigcg_params.h.

Referenced by Chroma::read(), and Chroma::write().

MaxCG

int Chroma::SysSolverEigCGParams::MaxCG

Maximum CG iterations

Definition at line 25 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

Neig

int Chroma::SysSolverEigCGParams::Neig

number of eigenvectors to compute

Definition at line 27 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::LinOpSysSolverEigCGArray< T >::LinOpSysSolverEigCGArray(), Chroma::MdagMSysSolverQDPEigCG< T >::MdagMSysSolverQDPEigCG(), Chroma::read(), and Chroma::write().

Neig_max

int Chroma::SysSolverEigCGParams::Neig_max

maximum number of eigenvectors to be refined

Definition at line 30 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::LinOpSysSolverEigCGArray< T >::LinOpSysSolverEigCGArray(), Chroma::MdagMSysSolverQDPEigCG< T >::MdagMSysSolverQDPEigCG(), Chroma::read(), and Chroma::write().

Nmax

int Chroma::SysSolverEigCGParams::Nmax

number of basis vectors

Definition at line 28 of file syssolver_eigcg_params.h.

Referenced by Chroma::read(), and Chroma::write().

NormAest

Real Chroma::SysSolverEigCGParams::NormAest

Definition at line 45 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

PrintLevel

int Chroma::SysSolverEigCGParams::PrintLevel

Debugg level

Definition at line 26 of file syssolver_eigcg_params.h.

Referenced by defaults(), and Chroma::read().

restartTol

Real Chroma::SysSolverEigCGParams::restartTol

CG restart tolerence: restart when |res|<restartTol*|b-A x(0)|

Definition at line 32 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

RsdCG

Real Chroma::SysSolverEigCGParams::RsdCG

CG residual

Definition at line 24 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

updateRestartTol

int Chroma::SysSolverEigCGParams::updateRestartTol

Whether to update restartTol from eresids Expensive. Requires computation of residuals =0 Never update restartTol =1 Compute all eigenresiduals and update when ncurEvals=ldh for the first time =2 Update based on up to 10 eres picked from ncurEvals, on every rhs that adds evecs =3 Compute all eres and update on every rhs that adds evecs–unnecessarily expensive If updateRestartTol>0 Cholesky is not used

Definition at line 35 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

vPrecCGvecs

int Chroma::SysSolverEigCGParams::vPrecCGvecs

number of vectors for preconditioned CG (if <=0 do regular CG)

Definition at line 49 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

vPrecCGvecStart

int Chroma::SysSolverEigCGParams::vPrecCGvecStart

first std::vector used inpreconditioned CG

Definition at line 50 of file syssolver_eigcg_params.h.

Referenced by defaults(), Chroma::read(), and Chroma::write().

---

The documentation for this struct was generated from the following files:

• syssolver_eigcg_params.h
• syssolver_eigcg_params.cc