CHROMA: Chroma::SpatialTwoPlaqGaugeAct Class Reference

CHROMA

Plaquette gauge action. More...

#include <spatial_two_plaq_gaugeact.h>

Inheritance diagram for Chroma::SpatialTwoPlaqGaugeAct:

Public Member Functions
	SpatialTwoPlaqGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &coeff, const AnisoParam_t &aniso)
	General CreateGaugeState<P,Q> More...

	SpatialTwoPlaqGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const SpatialTwoPlaqGaugeActParams &p)
	Read coeff 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...

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

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

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

const Real	getCoeff (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
	SpatialTwoPlaqGaugeAct ()

void	operator= (const SpatialTwoPlaqGaugeAct &a)

void	init ()
	Hide assignment. More...

Private Attributes
Handle< CreateGaugeState< P, Q > >	cgs

SpatialTwoPlaqGaugeActParams	param

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

typedef multi1d< LatticeColorMatrix >	Q

Detailed Description

Plaquette gauge action.

The standard Plaquette gauge action

Definition at line 47 of file spatial_two_plaq_gaugeact.h.

Constructor & Destructor Documentation

◆ SpatialTwoPlaqGaugeAct() [1/3]

Chroma::SpatialTwoPlaqGaugeAct::SpatialTwoPlaqGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const Real &	coeff,
		const AnisoParam_t &	aniso
	)

inline

General CreateGaugeState<P,Q>

Definition at line 51 of file spatial_two_plaq_gaugeact.h.

References Chroma::SpatialTwoPlaqGaugeActParams::aniso, Chroma::SpatialTwoPlaqGaugeActParams::coeff, init(), and param.

◆ SpatialTwoPlaqGaugeAct() [2/3]

Chroma::SpatialTwoPlaqGaugeAct::SpatialTwoPlaqGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const SpatialTwoPlaqGaugeActParams &	p
	)

inline

Read coeff from a param struct.

Definition at line 57 of file spatial_two_plaq_gaugeact.h.

References init().

◆ ~SpatialTwoPlaqGaugeAct()

Chroma::SpatialTwoPlaqGaugeAct::~SpatialTwoPlaqGaugeAct ( )

inline

Destructor is automatic.

Definition at line 90 of file spatial_two_plaq_gaugeact.h.

◆ SpatialTwoPlaqGaugeAct() [3/3]

Chroma::SpatialTwoPlaqGaugeAct::SpatialTwoPlaqGaugeAct ( )

inlineprotected

Definition at line 96 of file spatial_two_plaq_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

const Real Chroma::SpatialTwoPlaqGaugeAct::anisoFactor ( ) const

inline

Anisotropy factor.

Definition at line 65 of file spatial_two_plaq_gaugeact.h.

References Chroma::SpatialTwoPlaqGaugeActParams::aniso, param, and Chroma::AnisoParam_t::xi_0.

◆ anisoP()

bool Chroma::SpatialTwoPlaqGaugeAct::anisoP ( ) const

inline

Is anisotropy used?

Definition at line 62 of file spatial_two_plaq_gaugeact.h.

References Chroma::SpatialTwoPlaqGaugeActParams::aniso, Chroma::AnisoParam_t::anisoP, and param.

Referenced by init().

◆ deriv()

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

virtual

Compute dS/dU.

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

Referenced by main().

◆ getCoeff()

const Real Chroma::SpatialTwoPlaqGaugeAct::getCoeff ( void ) const

inline

Definition at line 93 of file spatial_two_plaq_gaugeact.h.

References Chroma::SpatialTwoPlaqGaugeActParams::coeff, and param.

◆ getCreateState()

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

inlinevirtual

Produce a gauge create state object.

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

Definition at line 84 of file spatial_two_plaq_gaugeact.h.

References cgs.

◆ getSet()

const Set& Chroma::SpatialTwoPlaqGaugeAct::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 72 of file spatial_two_plaq_gaugeact.h.

◆ init()

void Chroma::SpatialTwoPlaqGaugeAct::init ( void )

protected

Hide assignment.

Internal initializer

Definition at line 72 of file spatial_two_plaq_gaugeact.cc.

References Chroma::SpatialTwoPlaqGaugeActParams::aniso, anisoP(), Chroma::SpatialTwoPlaqGaugeActParams::coeff, Chroma::END_CODE(), param, Chroma::START_CODE(), Chroma::AnisoParam_t::t_dir, and Chroma::AnisoParam_t::xi_0.

Referenced by SpatialTwoPlaqGaugeAct().

◆ operator=()

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

inlineprotected

Definition at line 97 of file spatial_two_plaq_gaugeact.h.

◆ S()

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

virtual

Compute the actions.

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

Referenced by main().

◆ staple()

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

virtual

Compute staple.

Parameters

u_mu_staple	result ( Write )
state	gauge field ( Read )
mu	direction for staple ( Read )
cb	subset on which to compute ( Read )

Implements Chroma::LinearGaugeAction.

Definition at line 95 of file spatial_two_plaq_gaugeact.cc.

◆ tDir()

int Chroma::SpatialTwoPlaqGaugeAct::tDir ( ) const

inline

Anisotropic direction.

Definition at line 68 of file spatial_two_plaq_gaugeact.h.

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

Member Data Documentation

◆ cgs

Handle< CreateGaugeState<P,Q> > Chroma::SpatialTwoPlaqGaugeAct::cgs

private

Definition at line 103 of file spatial_two_plaq_gaugeact.h.

Referenced by getCreateState().

◆ param

SpatialTwoPlaqGaugeActParams Chroma::SpatialTwoPlaqGaugeAct::param

private

Definition at line 104 of file spatial_two_plaq_gaugeact.h.

Referenced by anisoFactor(), anisoP(), getCoeff(), init(), SpatialTwoPlaqGaugeAct(), and tDir().

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