#include <asolver_Richardson.h>

Inheritance diagram for ASolver_Richardson< AFIELD >:

Public Types
typedef AFIELD::real_t	real_t

using	InitialGuess = typename ASolver< AFIELD >::InitialGuess

Public Types inherited from ASolver< AFIELD >
enum	InitialGuess { RHS, GIVEN, ZERO }

typedef AFIELD::real_t	real_t

Public Member Functions
	ASolver_Richardson (AFopr< AFIELD > fopr, APrecond< AFIELD > prec)
	constructor. More...

	~ASolver_Richardson ()
	destructor. More...

void	set_parameters (const Parameters &params)
	setting parameters by a Parameter object. More...

void	set_parameters (const int Niter, const real_t Stop_cond)
	setting parameters. More...

void	set_parameters (const int Niter, const real_t Stop_cond, const InitialGuess init_guess_mode)
	setting parameters. More...

void	set_parameters (const int Niter, const real_t Stop_cond, const bool use_init_guess)
	setting parameters. More...

void	solve (AFIELD &xq, const AFIELD &b, int &nconv, real_t &diff)
	solver main. More...

AFopr< AFIELD > *	get_afopr ()
	returns the pointer to the fermion operator. More...

double	flop_count ()
	returns the floating point operation count. More...

Public Member Functions inherited from ASolver< AFIELD >
	ASolver ()

virtual	~ASolver ()

void	set_parameter_verboselevel (const Bridge::VerboseLevel vl)

virtual void	set_init_mode (const InitialGuess init_guess)

virtual AFopr< AFIELD > *	get_fopr ()

Static Public Attributes
static const std::string	class_name = "ASolver_Richardson"

Protected Member Functions
	ASolver_Richardson ()
	calling constructor without fermion operator is forbidden. More...

void	init (void)
	initial setup. More...

void	tidyup (void)
	final tidy-up. More...

void	solve_init (const AFIELD &b, const AFIELD &xq, real_t &rr)

void	prec (AFIELD &, AFIELD &)

double	flop_count_intermediate (const int iter)

Protected Attributes
int	m_nconv
	to remember convergence iteration to provide flop count. More...

InitialGuess	m_initial_mode

Protected Attributes inherited from ASolver< AFIELD >
Bridge::VerboseLevel	m_vl

Private Attributes
AFopr< AFIELD > *	m_fopr
	fermion operator. More...

APrecond< AFIELD > *	m_prec
	preconditioner. More...

int	m_Niter
	maximum iteration number. More...

real_t	m_Stop_cond
	stopping criterion (squared). More...

real_t	m_Stop_cond2
	stopping criterion for inner solver. More...

AFIELD	m_r
	Matsufuru added: new AField_dev implementation. More...

AFIELD	m_s

Detailed Description

template<typename AFIELD>
class ASolver_Richardson< AFIELD >

Definition at line 30 of file asolver_Richardson.h.

Member Typedef Documentation

◆ InitialGuess

template<typename AFIELD >

using ASolver_Richardson< AFIELD >::InitialGuess = typename ASolver<AFIELD>::InitialGuess

Definition at line 36 of file asolver_Richardson.h.

◆ real_t

template<typename AFIELD >

typedef AFIELD::real_t ASolver_Richardson< AFIELD >::real_t

Definition at line 33 of file asolver_Richardson.h.

Constructor & Destructor Documentation

◆ ASolver_Richardson() [1/2]

template<typename AFIELD >

ASolver_Richardson< AFIELD >::ASolver_Richardson ( )

inlineprotected

calling constructor without fermion operator is forbidden.

Definition at line 60 of file asolver_Richardson.h.

◆ ASolver_Richardson() [2/2]

template<typename AFIELD >

ASolver_Richardson< AFIELD >::ASolver_Richardson	(	AFopr< AFIELD > *	fopr,
		APrecond< AFIELD > *	prec
	)

inline

constructor.

Definition at line 64 of file asolver_Richardson.h.

◆ ~ASolver_Richardson()

template<typename AFIELD >

ASolver_Richardson< AFIELD >::~ASolver_Richardson ( )

inline

destructor.

Definition at line 74 of file asolver_Richardson.h.

Member Function Documentation

◆ flop_count()

template<typename AFIELD >

double ASolver_Richardson< AFIELD >::flop_count

virtual

returns the floating point operation count.

Reimplemented from ASolver< AFIELD >.

Definition at line 227 of file asolver_Richardson-tmpl.h.

◆ flop_count_intermediate()

template<typename AFIELD >

double ASolver_Richardson< AFIELD >::flop_count_intermediate ( const int iter )

protected

Definition at line 235 of file asolver_Richardson-tmpl.h.

◆ get_afopr()

template<typename AFIELD >

AFopr<AFIELD>* ASolver_Richardson< AFIELD >::get_afopr ( )

inline

returns the pointer to the fermion operator.

Definition at line 92 of file asolver_Richardson.h.

◆ init()

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::init ( void )

protected

initial setup.

Definition at line 24 of file asolver_Richardson-tmpl.h.

◆ prec()

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::prec	(	AFIELD &	,
		AFIELD &
	)

protected

◆ set_parameters() [1/4]

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::set_parameters	(	const int	Niter,
		const real_t	Stop_cond
	)

setting parameters.

Definition at line 107 of file asolver_Richardson-tmpl.h.

◆ set_parameters() [2/4]

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::set_parameters	(	const int	Niter,
		const real_t	Stop_cond,
		const bool	use_init_guess
	)

setting parameters.

Definition at line 116 of file asolver_Richardson-tmpl.h.

◆ set_parameters() [3/4]

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::set_parameters	(	const int	Niter,
		const real_t	Stop_cond,
		const InitialGuess	init_guess_mode
	)

setting parameters.

Definition at line 80 of file asolver_Richardson-tmpl.h.

◆ set_parameters() [4/4]

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::set_parameters ( const Parameters & params )

virtual

setting parameters by a Parameter object.

Implements ASolver< AFIELD >.

Definition at line 49 of file asolver_Richardson-tmpl.h.

◆ solve()

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::solve	(	AFIELD &	xq,
		const AFIELD &	b,
		int &	nconv,
		real_t &	diff
	)

virtual

solver main.

Reimplemented from ASolver< AFIELD >.

Definition at line 131 of file asolver_Richardson-tmpl.h.

◆ solve_init()

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::solve_init	(	const AFIELD &	b,
		const AFIELD &	xq,
		real_t &	rr
	)

protected

Definition at line 218 of file asolver_Richardson-tmpl.h.

◆ tidyup()

template<typename AFIELD >

void ASolver_Richardson< AFIELD >::tidyup ( void )

protected

final tidy-up.

Definition at line 40 of file asolver_Richardson-tmpl.h.

Member Data Documentation

◆ class_name

template<typename AFIELD >

const std::string ASolver_Richardson< AFIELD >::class_name = "ASolver_Richardson"

static

Definition at line 35 of file asolver_Richardson.h.

◆ m_fopr

template<typename AFIELD >

AFopr<AFIELD>* ASolver_Richardson< AFIELD >::m_fopr

private

fermion operator.

Definition at line 41 of file asolver_Richardson.h.

◆ m_initial_mode

template<typename AFIELD >

InitialGuess ASolver_Richardson< AFIELD >::m_initial_mode

protected

Definition at line 57 of file asolver_Richardson.h.

◆ m_nconv

template<typename AFIELD >

int ASolver_Richardson< AFIELD >::m_nconv

protected

to remember convergence iteration to provide flop count.

Definition at line 55 of file asolver_Richardson.h.

◆ m_Niter

template<typename AFIELD >

int ASolver_Richardson< AFIELD >::m_Niter

private

maximum iteration number.

Definition at line 44 of file asolver_Richardson.h.

◆ m_prec

template<typename AFIELD >

APrecond<AFIELD>* ASolver_Richardson< AFIELD >::m_prec

private

preconditioner.

Definition at line 42 of file asolver_Richardson.h.

◆ m_r

template<typename AFIELD >

AFIELD ASolver_Richardson< AFIELD >::m_r

private

Matsufuru added: new AField_dev implementation.

Definition at line 49 of file asolver_Richardson.h.

◆ m_s

template<typename AFIELD >

AFIELD ASolver_Richardson< AFIELD >::m_s

private

Definition at line 49 of file asolver_Richardson.h.

◆ m_Stop_cond

template<typename AFIELD >

real_t ASolver_Richardson< AFIELD >::m_Stop_cond

private

stopping criterion (squared).

Definition at line 45 of file asolver_Richardson.h.

◆ m_Stop_cond2

template<typename AFIELD >

real_t ASolver_Richardson< AFIELD >::m_Stop_cond2

private

stopping criterion for inner solver.

Definition at line 46 of file asolver_Richardson.h.

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

src/lib_alt/Solver/asolver_Richardson.h
src/lib_alt/Solver/asolver_Richardson-tmpl.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

template<typename AFIELD> class ASolver_Richardson< AFIELD >

Member Typedef Documentation

◆ InitialGuess

◆ real_t

Constructor & Destructor Documentation

◆ ASolver_Richardson() [1/2]

◆ ASolver_Richardson() [2/2]

◆ ~ASolver_Richardson()

Member Function Documentation

◆ flop_count()

◆ flop_count_intermediate()

◆ get_afopr()

◆ init()

◆ prec()

◆ set_parameters() [1/4]

◆ set_parameters() [2/4]

◆ set_parameters() [3/4]

◆ set_parameters() [4/4]

◆ solve()

◆ solve_init()

◆ tidyup()

Member Data Documentation

◆ class_name

◆ m_fopr

◆ m_initial_mode

◆ m_nconv

◆ m_Niter

◆ m_prec

◆ m_r

◆ m_s

◆ m_Stop_cond

◆ m_Stop_cond2

template<typename AFIELD>
class ASolver_Richardson< AFIELD >