LWTree gauge action. More...

#include <lw_tree_gaugeact.h>

Inheritance diagram for Chroma::LWTreeGaugeAct:

Public Types
typedef multi1d< LatticeColorMatrix >	P

typedef multi1d< LatticeColorMatrix >	Q

Public Types inherited from Chroma::LinearGaugeAction
typedef multi1d< LatticeColorMatrix >	P

typedef multi1d< LatticeColorMatrix >	Q

Public Member Functions
	LWTreeGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const LWTreeGaugeActParams &p)
	Read beta from a param struct. More...

bool	anisoP () const
	Is anisotropy used? More...

const Real	anisoFactor () const
	Anisotropy factor. More...

int	tDir () const
	Anisotropic direction. More...

const Set &	getSet () const
	Return the set on which the gauge action is defined. More...

void	staple (LatticeColorMatrix &result, const Handle< GaugeState< P, Q > > &state, int mu, int cb) const
	Compute staple. More...

void	deriv (multi1d< LatticeColorMatrix > &result, const Handle< GaugeState< P, Q > > &state) const
	Compute dS/dU. More...

Double	S (const Handle< GaugeState< P, Q > > &state) const
	Compute the actions. More...

const CreateGaugeState< P, Q > &	getCreateState () const
	Produce a gauge create state object. More...

	~LWTreeGaugeAct ()
	Destructor is automatic. More...

const Real	getBeta (void) const

Public Member Functions inherited from Chroma::LinearGaugeAction
virtual	~LinearGaugeAction ()
	Virtual destructor to help with cleanup;. More...

Public Member Functions inherited from Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >
virtual	~GaugeAction ()
	Virtual destructor to help with cleanup;. More...

virtual GaugeState< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > *	createState (const multi1d< LatticeColorMatrix > &q) const
	Given links, create the state. More...

virtual const GaugeBC< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > &	getGaugeBC () const
	Return the gauge BC object for this action. More...

Protected Member Functions
void	init (Handle< CreateGaugeState< P, Q > > cgs)
	Private initializer. More...

void	operator= (const LWTreeGaugeAct &a)
	Hide assignment. More...

Private Attributes
Handle< PlaqGaugeAct >	plaq

Handle< RectGaugeAct >	rect

LWTreeGaugeActParams	param

Detailed Description

LWTree gauge action.

The standard LWTree gauge action

Definition at line 48 of file lw_tree_gaugeact.h.

Member Typedef Documentation

◆ P

typedef multi1d<LatticeColorMatrix> Chroma::LWTreeGaugeAct::P

Definition at line 52 of file lw_tree_gaugeact.h.

◆ Q

typedef multi1d<LatticeColorMatrix> Chroma::LWTreeGaugeAct::Q

Definition at line 53 of file lw_tree_gaugeact.h.

Constructor & Destructor Documentation

◆ LWTreeGaugeAct()

Chroma::LWTreeGaugeAct::LWTreeGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const LWTreeGaugeActParams &	p
	)

inline

Read beta from a param struct.

Definition at line 56 of file lw_tree_gaugeact.h.

References init().

◆ ~LWTreeGaugeAct()

Chroma::LWTreeGaugeAct::~LWTreeGaugeAct ( )

inline

Destructor is automatic.

Definition at line 107 of file lw_tree_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

const Real Chroma::LWTreeGaugeAct::anisoFactor ( ) const

inline

Anisotropy factor.

Definition at line 64 of file lw_tree_gaugeact.h.

◆ anisoP()

bool Chroma::LWTreeGaugeAct::anisoP ( ) const

inline

Is anisotropy used?

Definition at line 61 of file lw_tree_gaugeact.h.

◆ deriv()

void Chroma::LWTreeGaugeAct::deriv	(	multi1d< LatticeColorMatrix > &	result,
		const Handle< GaugeState< P, Q > > &	state
	)		const

inlinevirtual

Compute dS/dU.

Reimplemented from Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 87 of file lw_tree_gaugeact.h.

References plaq, rect, Chroma::state, and Chroma::tmp.

◆ getBeta()

const Real Chroma::LWTreeGaugeAct::getBeta ( void ) const

inline

Definition at line 110 of file lw_tree_gaugeact.h.

References Chroma::LWTreeGaugeActParams::beta, and param.

◆ getCreateState()

const CreateGaugeState<P,Q>& Chroma::LWTreeGaugeAct::getCreateState ( ) const

inlinevirtual

Produce a gauge create state object.

Implements Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 104 of file lw_tree_gaugeact.h.

References plaq.

◆ getSet()

const Set& Chroma::LWTreeGaugeAct::getSet ( void ) const

inlinevirtual

Return the set on which the gauge action is defined.

Defined on the even-off (red/black) set

Implements Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 71 of file lw_tree_gaugeact.h.

◆ init()

void Chroma::LWTreeGaugeAct::init ( Handle< CreateGaugeState< P, Q > > cgs )

protected

Private initializer.

Definition at line 67 of file lw_tree_gaugeact.cc.

References Chroma::LWTreeGaugeActParams::aniso, Chroma::LWTreeGaugeActParams::beta, Chroma::END_CODE(), param, plaq, rect, Chroma::START_CODE(), and Chroma::LWTreeGaugeActParams::u0.

Referenced by LWTreeGaugeAct().

◆ operator=()

void Chroma::LWTreeGaugeAct::operator= ( const LWTreeGaugeAct & a )

inlineprotected

Hide assignment.

Definition at line 117 of file lw_tree_gaugeact.h.

◆ S()

Double Chroma::LWTreeGaugeAct::S ( const Handle< GaugeState< P, Q > > & state ) const

inlinevirtual

Compute the actions.

Implements Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 98 of file lw_tree_gaugeact.h.

References plaq, rect, and Chroma::state.

◆ staple()

void Chroma::LWTreeGaugeAct::staple	(	LatticeColorMatrix &	result,
		const Handle< GaugeState< P, Q > > &	state,
		int	mu,
		int	cb
	)		const

inlinevirtual

Compute staple.

Default version. Derived class should override this if needed.

Implements Chroma::LinearGaugeAction.

Definition at line 75 of file lw_tree_gaugeact.h.

References Chroma::cb, mu, plaq, rect, Chroma::state, and Chroma::tmp.

◆ tDir()

int Chroma::LWTreeGaugeAct::tDir ( ) const

inline

Anisotropic direction.

Definition at line 67 of file lw_tree_gaugeact.h.

References Chroma::LWTreeGaugeActParams::aniso, param, and Chroma::AnisoParam_t::t_dir.

Member Data Documentation

◆ param

LWTreeGaugeActParams Chroma::LWTreeGaugeAct::param

private

The coupling Beta

Definition at line 122 of file lw_tree_gaugeact.h.

Referenced by getBeta(), init(), and tDir().

◆ plaq

Handle<PlaqGaugeAct> Chroma::LWTreeGaugeAct::plaq

private

Hold a plaquette gaugeact

Definition at line 120 of file lw_tree_gaugeact.h.

Referenced by deriv(), getCreateState(), init(), S(), and staple().

◆ rect

Handle<RectGaugeAct> Chroma::LWTreeGaugeAct::rect

private

Hold a rectangle gaugeact

Definition at line 121 of file lw_tree_gaugeact.h.

Referenced by deriv(), init(), S(), and staple().

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ P

◆ Q

Constructor & Destructor Documentation

◆ LWTreeGaugeAct()

◆ ~LWTreeGaugeAct()

Member Function Documentation

◆ anisoFactor()

◆ anisoP()

◆ deriv()

◆ getBeta()

◆ getCreateState()

◆ getSet()

◆ init()

◆ operator=()

◆ S()

◆ staple()

◆ tDir()

Member Data Documentation

◆ param

◆ plaq

◆ rect