Chroma::SysSolverOptEigCGParams Struct Reference

Params for EigCG inverter. More...

#include <syssolver_OPTeigcg_params.h>

Classes
struct	File_t

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

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

Detailed Description

Params for EigCG inverter.

Definition at line 17 of file syssolver_OPTeigcg_params.h.

Constructor & Destructor Documentation

SysSolverOptEigCGParams() [1/2]

Chroma::SysSolverOptEigCGParams::SysSolverOptEigCGParams

(

)

Default constructor.

Definition at line 106 of file syssolver_OPTeigcg_params.cc.

References defaults().

SysSolverOptEigCGParams() [2/2]

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

Read parameters.

Definition at line 112 of file syssolver_OPTeigcg_params.cc.

References Chroma::read().

Member Function Documentation

defaults()

void Chroma::SysSolverOptEigCGParams::defaults ( )

inline

Definition at line 57 of file syssolver_OPTeigcg_params.h.

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

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

Member Data Documentation

cleanUpEvecs

bool Chroma::SysSolverOptEigCGParams::cleanUpEvecs

clean up evecs upon destruction of SystemSolver

Definition at line 45 of file syssolver_OPTeigcg_params.h.

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

eigen_id

std::string Chroma::SysSolverOptEigCGParams::eigen_id

named buffer holding the eigenvectors

Definition at line 46 of file syssolver_OPTeigcg_params.h.

Referenced by defaults(), Chroma::MdagMSysSolverOptEigCG< T >::MdagMSysSolverOptEigCG(), Chroma::MdagMSysSolverOptEigCG< T >::QIOReadOptEvecs(), Chroma::MdagMSysSolverOptEigCG< T >::QIOWriteOptEvecs(), Chroma::read(), Chroma::write(), and Chroma::MdagMSysSolverOptEigCG< T >::~MdagMSysSolverOptEigCG().

esize

int Chroma::SysSolverOptEigCGParams::esize

2 <= esize <= 2*Neig + 1

Definition at line 27 of file syssolver_OPTeigcg_params.h.

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

file

struct Chroma::SysSolverOptEigCGParams::File_t Chroma::SysSolverOptEigCGParams::file

Referenced by defaults(), Chroma::MdagMSysSolverOptEigCG< T >::MdagMSysSolverOptEigCG(), Chroma::MdagMSysSolverOptEigCG< T >::QIOReadOptEvecs(), Chroma::MdagMSysSolverOptEigCG< T >::QIOWriteOptEvecs(), Chroma::read(), Chroma::write(), and Chroma::MdagMSysSolverOptEigCG< T >::~MdagMSysSolverOptEigCG().

MaxCG

int Chroma::SysSolverOptEigCGParams::MaxCG

Maximum CG iterations

Definition at line 23 of file syssolver_OPTeigcg_params.h.

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

Neig

int Chroma::SysSolverOptEigCGParams::Neig

number of eigenvectors to compute

Definition at line 25 of file syssolver_OPTeigcg_params.h.

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

Neig_max

int Chroma::SysSolverOptEigCGParams::Neig_max

maximum number of eigenvectors to be refined

Definition at line 28 of file syssolver_OPTeigcg_params.h.

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

Nmax

int Chroma::SysSolverOptEigCGParams::Nmax

number of basis vectors

Definition at line 26 of file syssolver_OPTeigcg_params.h.

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

NormAest

Real Chroma::SysSolverOptEigCGParams::NormAest

Definition at line 43 of file syssolver_OPTeigcg_params.h.

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

PrintLevel

int Chroma::SysSolverOptEigCGParams::PrintLevel

Debugg level

Definition at line 24 of file syssolver_OPTeigcg_params.h.

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

restartTol

Real Chroma::SysSolverOptEigCGParams::restartTol

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

Definition at line 30 of file syssolver_OPTeigcg_params.h.

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

RsdCG

Real Chroma::SysSolverOptEigCGParams::RsdCG

CG residual

Definition at line 22 of file syssolver_OPTeigcg_params.h.

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

updateRestartTol

int Chroma::SysSolverOptEigCGParams::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 33 of file syssolver_OPTeigcg_params.h.

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

---

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

• syssolver_OPTeigcg_params.h
• syssolver_OPTeigcg_params.cc