CHROMA: Chroma::SysSolverOptEigBiCGParams Struct Reference

CHROMA

Params for EigBiCG inverter. More...

#include <syssolver_OPTeigbicg_params.h>

Classes
struct	File_t

Public Member Functions
	SysSolverOptEigBiCGParams ()
	Default constructor. More...

	SysSolverOptEigBiCGParams (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

Real	NormAest

std::string	sort_option

Real	epsi

int	ConvTestOpt

bool	cleanUpEvecs

std::string	eigen_id

struct Chroma::SysSolverOptEigBiCGParams::File_t	file

Detailed Description

Params for EigBiCG inverter.

Definition at line 17 of file syssolver_OPTeigbicg_params.h.

Constructor & Destructor Documentation

◆ SysSolverOptEigBiCGParams() [1/2]

Chroma::SysSolverOptEigBiCGParams::SysSolverOptEigBiCGParams ( )

Default constructor.

Definition at line 116 of file syssolver_OPTeigbicg_params.cc.

References defaults().

◆ SysSolverOptEigBiCGParams() [2/2]

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

Read parameters.

Definition at line 122 of file syssolver_OPTeigbicg_params.cc.

References Chroma::read().

Member Function Documentation

◆ defaults()

void Chroma::SysSolverOptEigBiCGParams::defaults ( )

inline

Definition at line 60 of file syssolver_OPTeigbicg_params.h.

References cleanUpEvecs, ConvTestOpt, eigen_id, epsi, esize, file, Chroma::SysSolverOptEigBiCGParams::File_t::file_name, Chroma::SysSolverOptEigBiCGParams::File_t::file_volfmt, MaxCG, Neig, Neig_max, NormAest, PrintLevel, Chroma::SysSolverOptEigBiCGParams::File_t::read, restartTol, RsdCG, sort_option, Chroma::SysSolverOptEigBiCGParams::File_t::write, and Chroma::zero.

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

Member Data Documentation

◆ cleanUpEvecs

bool Chroma::SysSolverOptEigBiCGParams::cleanUpEvecs

clean up evecs upon destruction of SystemSolver

Definition at line 48 of file syssolver_OPTeigbicg_params.h.

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

◆ ConvTestOpt

int Chroma::SysSolverOptEigBiCGParams::ConvTestOpt

Definition at line 44 of file syssolver_OPTeigbicg_params.h.

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

◆ eigen_id

std::string Chroma::SysSolverOptEigBiCGParams::eigen_id

named buffer holding the eigenvectors

Definition at line 49 of file syssolver_OPTeigbicg_params.h.

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

◆ epsi

Real Chroma::SysSolverOptEigBiCGParams::epsi

Definition at line 38 of file syssolver_OPTeigbicg_params.h.

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

◆ esize

int Chroma::SysSolverOptEigBiCGParams::esize

2*lde+2*nev <= esize <= 2*(nev+1)*lde

Definition at line 27 of file syssolver_OPTeigbicg_params.h.

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

◆ file

struct Chroma::SysSolverOptEigBiCGParams::File_t Chroma::SysSolverOptEigBiCGParams::file

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

◆ MaxCG

int Chroma::SysSolverOptEigBiCGParams::MaxCG

Maximum CG iterations

Definition at line 23 of file syssolver_OPTeigbicg_params.h.

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

◆ Neig

int Chroma::SysSolverOptEigBiCGParams::Neig

number of eigenvectors to compute

Definition at line 25 of file syssolver_OPTeigbicg_params.h.

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

◆ Neig_max

int Chroma::SysSolverOptEigBiCGParams::Neig_max

maximum number of eigenvectors to be refined

Definition at line 28 of file syssolver_OPTeigbicg_params.h.

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

◆ Nmax

int Chroma::SysSolverOptEigBiCGParams::Nmax

number of basis vectors

Definition at line 26 of file syssolver_OPTeigbicg_params.h.

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

◆ NormAest

Real Chroma::SysSolverOptEigBiCGParams::NormAest

Definition at line 33 of file syssolver_OPTeigbicg_params.h.

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

◆ PrintLevel

int Chroma::SysSolverOptEigBiCGParams::PrintLevel

Debugg level

Definition at line 24 of file syssolver_OPTeigbicg_params.h.

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

◆ restartTol

Real Chroma::SysSolverOptEigBiCGParams::restartTol

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

Definition at line 30 of file syssolver_OPTeigbicg_params.h.

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

◆ RsdCG

Real Chroma::SysSolverOptEigBiCGParams::RsdCG

CG residual

Definition at line 22 of file syssolver_OPTeigbicg_params.h.

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

◆ sort_option

std::string Chroma::SysSolverOptEigBiCGParams::sort_option

Definition at line 35 of file syssolver_OPTeigbicg_params.h.

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

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