CHROMA: Chroma::AnisoSymSpatialGaugeAct Class Reference

CHROMA

Spatial anisotropic Symanzik improved gauge action. More...

#include <aniso_sym_spatial_gaugeact.h>

Inheritance diagram for Chroma::AnisoSymSpatialGaugeAct:

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

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

const Real	getBeta (void) const

const Real	getUS (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 (void)
	Private initializer. More...

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

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

AnisoSymSpatialGaugeActParams	param

Real	plaq_c_s

Real	rect_c_s

Detailed Description

Spatial anisotropic Symanzik improved gauge action.

Contains space-space plaquette and space space rectangle terms only. Useful for when one wants to split the spatial and temporal parts of the general Symanzik gauge action onto different timescales in an (R)HMC simulation.

Definition at line 35 of file aniso_sym_spatial_gaugeact.h.

Member Typedef Documentation

◆ P

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

Definition at line 39 of file aniso_sym_spatial_gaugeact.h.

◆ Q

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

Definition at line 40 of file aniso_sym_spatial_gaugeact.h.

Constructor & Destructor Documentation

◆ AnisoSymSpatialGaugeAct()

Chroma::AnisoSymSpatialGaugeAct::AnisoSymSpatialGaugeAct	(	Handle< CreateGaugeState< P, Q > >	cgs_,
		const AnisoSymSpatialGaugeActParams &	p
	)

inline

Read beta from a param struct.

Definition at line 43 of file aniso_sym_spatial_gaugeact.h.

References init().

◆ ~AnisoSymSpatialGaugeAct()

Chroma::AnisoSymSpatialGaugeAct::~AnisoSymSpatialGaugeAct ( )

inline

Destructor is automatic.

Definition at line 94 of file aniso_sym_spatial_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

const Real Chroma::AnisoSymSpatialGaugeAct::anisoFactor ( ) const

inline

Anisotropy factor.

Definition at line 51 of file aniso_sym_spatial_gaugeact.h.

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

◆ anisoP()

bool Chroma::AnisoSymSpatialGaugeAct::anisoP ( ) const

inline

Is anisotropy used?

Definition at line 48 of file aniso_sym_spatial_gaugeact.h.

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

◆ deriv()

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

virtual

Compute dS/dU.

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

Definition at line 92 of file aniso_sym_spatial_gaugeact.cc.

References Chroma::AnisoSymSpatialGaugeActParams::aniso, Chroma::AnisoSym::deriv_part(), Chroma::END_CODE(), Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >::getGaugeBC(), mu, Nd, nu, param, plaq_c_s, rect_c_s, Chroma::START_CODE(), Chroma::state, Chroma::AnisoParam_t::t_dir, Chroma::zero, and Chroma::GaugeBC< P, Q >::zero().

◆ getBeta()

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

inline

Definition at line 97 of file aniso_sym_spatial_gaugeact.h.

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

◆ getCreateState()

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

inlinevirtual

Produce a gauge create state object.

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

Definition at line 91 of file aniso_sym_spatial_gaugeact.h.

References cgs.

◆ getSet()

const Set& Chroma::AnisoSymSpatialGaugeAct::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 58 of file aniso_sym_spatial_gaugeact.h.

◆ getUS()

const Real Chroma::AnisoSymSpatialGaugeAct::getUS ( void ) const

inline

Definition at line 99 of file aniso_sym_spatial_gaugeact.h.

References param, and Chroma::AnisoSymSpatialGaugeActParams::u_s.

◆ init()

void Chroma::AnisoSymSpatialGaugeAct::init ( void )

protected

Private initializer.

Definition at line 145 of file aniso_sym_spatial_gaugeact.cc.

References Chroma::AnisoSymSpatialGaugeActParams::aniso, Chroma::AnisoParam_t::anisoP, Chroma::AnisoSymSpatialGaugeActParams::beta, Chroma::END_CODE(), param, plaq_c_s, rect_c_s, Chroma::START_CODE(), Chroma::AnisoSymSpatialGaugeActParams::u_s, and Chroma::AnisoParam_t::xi_0.

Referenced by AnisoSymSpatialGaugeAct().

◆ operator=()

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

inlineprotected

Hide assignment.

Definition at line 108 of file aniso_sym_spatial_gaugeact.h.

◆ S()

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

virtual

Compute the actions.

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

Definition at line 48 of file aniso_sym_spatial_gaugeact.cc.

References Chroma::AnisoSymSpatialGaugeActParams::aniso, Chroma::END_CODE(), mu, Nd, nu, param, plaq_c_s, rect_c_s, Chroma::AnisoSym::S_part(), Chroma::START_CODE(), Chroma::state, Chroma::AnisoSymSpatialGaugeActParams::sub_zero, sum, Chroma::AnisoParam_t::t_dir, Chroma::AnisoSymSpatialGaugeActParams::use_subtraction, and Chroma::zero.

◆ staple()

void Chroma::AnisoSymSpatialGaugeAct::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 62 of file aniso_sym_spatial_gaugeact.h.

◆ tDir()

int Chroma::AnisoSymSpatialGaugeAct::tDir ( ) const

inline

Anisotropic direction.

Definition at line 54 of file aniso_sym_spatial_gaugeact.h.

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

Member Data Documentation

◆ cgs

const Handle< CreateGaugeState<P,Q> > Chroma::AnisoSymSpatialGaugeAct::cgs

private

Definition at line 111 of file aniso_sym_spatial_gaugeact.h.

Referenced by getCreateState().

◆ param

AnisoSymSpatialGaugeActParams Chroma::AnisoSymSpatialGaugeAct::param

private

The couplings and anisotropy

Definition at line 112 of file aniso_sym_spatial_gaugeact.h.

Referenced by anisoFactor(), anisoP(), deriv(), getBeta(), getUS(), init(), S(), and tDir().

◆ plaq_c_s

Real Chroma::AnisoSymSpatialGaugeAct::plaq_c_s

private

Definition at line 116 of file aniso_sym_spatial_gaugeact.h.

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

◆ rect_c_s

Real Chroma::AnisoSymSpatialGaugeAct::rect_c_s

private

Definition at line 117 of file aniso_sym_spatial_gaugeact.h.

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

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