CHROMA
Public Member Functions | Protected Member Functions | Private Attributes | List of all members

Plaquette gauge action. More...

#include <plaq_plus_spatial_two_plaq_gaugeact.h>

Inheritance diagram for Chroma::PlaqPlusSpatialTwoPlaqGaugeAct:
Chroma::LinearGaugeAction Chroma::GaugeAction< multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >

Public Member Functions

 PlaqPlusSpatialTwoPlaqGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &coeff_plaq_s_, const Real &coeff_plaq_t_, const Real &coeff_two_plaq_, const AnisoParam_t &aniso)
 General CreateGaugeState<P,Q> More...
 
 PlaqPlusSpatialTwoPlaqGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const PlaqPlusSpatialTwoPlaqGaugeActParams &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...
 
 ~PlaqPlusSpatialTwoPlaqGaugeAct ()
 Destructor is automatic. More...
 
const Real getCoeffPlaqS (void) const
 
const Real getCoeffPlaqT (void) const
 
const Real getCoeffTwoPlaq (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

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

Private Attributes

Handle< CreateGaugeState< P, Q > > cgs
 
PlaqPlusSpatialTwoPlaqGaugeActParams 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 51 of file plaq_plus_spatial_two_plaq_gaugeact.h.

Constructor & Destructor Documentation

◆ PlaqPlusSpatialTwoPlaqGaugeAct() [1/3]

Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::PlaqPlusSpatialTwoPlaqGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const Real &  coeff_plaq_s_,
const Real &  coeff_plaq_t_,
const Real &  coeff_two_plaq_,
const AnisoParam_t aniso 
)
inline

◆ PlaqPlusSpatialTwoPlaqGaugeAct() [2/3]

Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::PlaqPlusSpatialTwoPlaqGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const PlaqPlusSpatialTwoPlaqGaugeActParams p 
)
inline

Read coeff from a param struct.

Definition at line 69 of file plaq_plus_spatial_two_plaq_gaugeact.h.

References init().

◆ ~PlaqPlusSpatialTwoPlaqGaugeAct()

Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::~PlaqPlusSpatialTwoPlaqGaugeAct ( )
inline

Destructor is automatic.

Definition at line 102 of file plaq_plus_spatial_two_plaq_gaugeact.h.

◆ PlaqPlusSpatialTwoPlaqGaugeAct() [3/3]

Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::PlaqPlusSpatialTwoPlaqGaugeAct ( )
inlineprotected

Definition at line 110 of file plaq_plus_spatial_two_plaq_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

const Real Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::anisoFactor ( ) const
inline

◆ anisoP()

bool Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::anisoP ( ) const
inline

Is anisotropy used?

Definition at line 74 of file plaq_plus_spatial_two_plaq_gaugeact.h.

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

Referenced by init().

◆ deriv()

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

◆ getCoeffPlaqS()

const Real Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::getCoeffPlaqS ( void  ) const
inline

◆ getCoeffPlaqT()

const Real Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::getCoeffPlaqT ( void  ) const
inline

◆ getCoeffTwoPlaq()

const Real Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::getCoeffTwoPlaq ( void  ) const
inline

◆ getCreateState()

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

Produce a gauge create state object.

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

Definition at line 96 of file plaq_plus_spatial_two_plaq_gaugeact.h.

References cgs.

◆ getSet()

const Set& Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::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 84 of file plaq_plus_spatial_two_plaq_gaugeact.h.

◆ init()

void Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::init ( void  )
protected

◆ operator=()

void Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::operator= ( const PlaqPlusSpatialTwoPlaqGaugeAct a)
inlineprotected

Definition at line 111 of file plaq_plus_spatial_two_plaq_gaugeact.h.

◆ S()

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

◆ staple()

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

Compute staple.

Parameters
u_mu_stapleresult ( Write )
stategauge field ( Read )
mudirection for staple ( Read )
cbsubset on which to compute ( Read )

Implements Chroma::LinearGaugeAction.

Definition at line 106 of file plaq_plus_spatial_two_plaq_gaugeact.cc.

◆ tDir()

int Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::tDir ( ) const
inline

Member Data Documentation

◆ cgs

Handle< CreateGaugeState<P,Q> > Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::cgs
private

Definition at line 117 of file plaq_plus_spatial_two_plaq_gaugeact.h.

Referenced by getCreateState().

◆ param

PlaqPlusSpatialTwoPlaqGaugeActParams Chroma::PlaqPlusSpatialTwoPlaqGaugeAct::param
private

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