Parallelogram gauge action. More...

#include <pg_gaugeact.h>

Inheritance diagram for Chroma::PgGaugeAct:

Public Member Functions
	PgGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &coeff_)
	General CreateGaugeState. More...

	PgGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const PgGaugeActParams &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...

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...

	~PgGaugeAct ()
	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
	PgGaugeAct ()
	Partial constructor. More...

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

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

Real	coeff

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

typedef multi1d< LatticeColorMatrix >	Q

Detailed Description

Parallelogram gauge action.

The standard parallelogram gauge action

Definition at line 44 of file pg_gaugeact.h.

Constructor & Destructor Documentation

◆ PgGaugeAct() [1/3]

Chroma::PgGaugeAct::PgGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const Real &	coeff_
	)

inline

General CreateGaugeState.

Definition at line 48 of file pg_gaugeact.h.

◆ PgGaugeAct() [2/3]

Chroma::PgGaugeAct::PgGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const PgGaugeActParams &	p
	)

inline

Read coeff from a param struct.

Definition at line 53 of file pg_gaugeact.h.

◆ ~PgGaugeAct()

Chroma::PgGaugeAct::~PgGaugeAct ( )

inline

Destructor is automatic.

Definition at line 87 of file pg_gaugeact.h.

◆ PgGaugeAct() [3/3]

Chroma::PgGaugeAct::PgGaugeAct ( )

inlineprotected

Partial constructor.

Definition at line 94 of file pg_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

const Real Chroma::PgGaugeAct::anisoFactor ( ) const

inline

Anisotropy factor.

Definition at line 61 of file pg_gaugeact.h.

◆ anisoP()

bool Chroma::PgGaugeAct::anisoP ( ) const

inline

Is anisotropy used?

Definition at line 58 of file pg_gaugeact.h.

◆ deriv()

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

virtual

Compute dS/dU.

Computes the derivative of the fermionic action respect to the link field.

    |  dS

ds_u – | -— ( Write ) | dU

Parameters

ds_u	result ( Write )
state	gauge field ( Read )

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

Definition at line 92 of file pg_gaugeact.cc.

References BACKWARD, Chroma::cb, coeff, Chroma::END_CODE(), Chroma::eta, FORWARD, Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >::getGaugeBC(), j, Chroma::k, mu, Nd, nu, Chroma::START_CODE(), Chroma::state, tmp_1, tmp_2, tmp_3, tmp_tot, Chroma::u, Chroma::zero, and Chroma::GaugeBC< P, Q >::zero().

◆ getCoeff()

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

inline

Definition at line 90 of file pg_gaugeact.h.

References coeff.

◆ getCreateState()

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

inlinevirtual

Produce a gauge create state object.

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

Definition at line 84 of file pg_gaugeact.h.

References cgs.

◆ getSet()

const Set& Chroma::PgGaugeAct::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 68 of file pg_gaugeact.h.

◆ operator=()

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

inlineprotected

Hide assignment.

Definition at line 96 of file pg_gaugeact.h.

◆ S()

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

virtual

Compute the actions.

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

Definition at line 240 of file pg_gaugeact.cc.

References BACKWARD, Chroma::cb, coeff, Chroma::END_CODE(), FORWARD, mu, Nd, nu, Chroma::START_CODE(), Chroma::state, sum, tmp_1, tmp_2, Chroma::u, and Chroma::zero.

◆ staple()

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

virtual

Compute staple.

Default version. Derived class should override this if needed.

Parameters

u_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 72 of file pg_gaugeact.cc.

◆ tDir()

int Chroma::PgGaugeAct::tDir ( ) const

inline

Anisotropic direction.

Definition at line 64 of file pg_gaugeact.h.

References Nd.

Member Data Documentation

◆ cgs

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

private

Definition at line 99 of file pg_gaugeact.h.

Referenced by getCreateState().

◆ coeff

Real Chroma::PgGaugeAct::coeff

private

Definition at line 100 of file pg_gaugeact.h.

Referenced by deriv(), getCoeff(), and S().

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PgGaugeAct() [1/3]

◆ PgGaugeAct() [2/3]

◆ ~PgGaugeAct()

◆ PgGaugeAct() [3/3]

Member Function Documentation

◆ anisoFactor()

◆ anisoP()

◆ deriv()

◆ getCoeff()

◆ getCreateState()

◆ getSet()

◆ operator=()

◆ S()

◆ staple()

◆ tDir()

Member Data Documentation

◆ cgs

◆ coeff