Staple Class Reference

Base class for Staple construction. More...

#include <staple.h>

Inheritance diagram for Staple:

Public Member Functions
	Staple ()
virtual	~Staple ()
virtual void	set_parameters (const Parameters &params)=0
	setting parameters. More...
virtual void	get_parameters (Parameters &params) const =0
	getting parameters. More...
virtual void	upper (Field_G &, const Field_G &, const int mu, const int nu)=0
	constructs upper staple in mu-nu plane. More...
virtual void	lower (Field_G &, const Field_G &, const int mu, const int nu)=0
	constructs lower staple in mu-nu plane. More...
virtual void	staple (Field_G &, const Field_G &, const int mu)=0
	constructs staple in mu-direction (summing up nu-direction). More...
virtual double	plaquette (const Field_G &)=0
	calculates plaquette value. More...
virtual double	plaq_s (const Field_G &)=0
	calculates spatial plaquette value. More...
virtual double	plaq_t (const Field_G &)=0
	calculates temporal plaquette value. More...

Private Member Functions
	Staple (const Staple &)
Staple &	operator= (const Staple &)

Detailed Description

Base class for Staple construction.

This class defines interface of Staple-type classes. [24 Jan 2017 Y.Namekawa]

Definition at line 33 of file staple.h.

Constructor & Destructor Documentation

Staple() [1/2]

Staple::Staple ( )

inline

Definition at line 36 of file staple.h.

~Staple()

virtual Staple::~Staple ( )

inlinevirtual

Definition at line 37 of file staple.h.

Staple() [2/2]

Staple::Staple ( const Staple &  )

private

Member Function Documentation

get_parameters()

virtual void Staple::get_parameters ( Parameters &  params ) const

pure virtual

getting parameters.

Implemented in Staple_lex, and Staple_eo.

lower()

virtual void Staple::lower ( Field_G &  , const Field_G &  , const int  mu, const int  nu  )

pure virtual

constructs lower staple in mu-nu plane.

Implemented in Staple_eo, and Staple_lex.

operator=()

Staple& Staple::operator= ( const Staple &  )

private

plaq_s()

virtual double Staple::plaq_s ( const Field_G &  )

pure virtual

calculates spatial plaquette value.

Implemented in Staple_lex, and Staple_eo.

plaq_t()

virtual double Staple::plaq_t ( const Field_G &  )

pure virtual

calculates temporal plaquette value.

Implemented in Staple_lex, and Staple_eo.

plaquette()

virtual double Staple::plaquette ( const Field_G &  )

pure virtual

calculates plaquette value.

Implemented in Staple_lex, and Staple_eo.

set_parameters()

virtual void Staple::set_parameters ( const Parameters &  params )

pure virtual

setting parameters.

Implemented in Staple_lex, and Staple_eo.

staple()

virtual void Staple::staple ( Field_G &  , const Field_G &  , const int  mu  )

pure virtual

constructs staple in mu-direction (summing up nu-direction).

Implemented in Staple_eo, and Staple_lex.

upper()

virtual void Staple::upper ( Field_G &  , const Field_G &  , const int  mu, const int  nu  )

pure virtual

constructs upper staple in mu-nu plane.

Implemented in Staple_eo, and Staple_lex.

---

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

• src/lib/Measurements/Gauge/staple.h