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

Wilson gauge action. More...

#include <wilson_gaugeact.h>

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

Public Member Functions

 WilsonGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &beta)
 General CreateGaugeState<P,Q> More...
 
 WilsonGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &beta, const AnisoParam_t &aniso)
 General CreateGaugeState<P,Q> More...
 
 WilsonGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const WilsonGaugeActParams &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...
 
 ~WilsonGaugeAct ()
 Destructor is automatic. More...
 
const Real getBeta (void) const
 
const CreateGaugeState< P, Q > & getCreateState () const
 Produce a gauge create state object. More...
 
- 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...
 
 WilsonGaugeAct ()
 Partial constructor. More...
 
void operator= (const WilsonGaugeAct &a)
 Hide assignment. More...
 

Private Attributes

Handle< PlaqGaugeActplaq
 
WilsonGaugeActParams param
 

Additional Inherited Members

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

Detailed Description

Wilson gauge action.

The standard Wilson gauge action

Definition at line 30 of file wilson_gaugeact.h.

Constructor & Destructor Documentation

◆ WilsonGaugeAct() [1/4]

Chroma::WilsonGaugeAct::WilsonGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const Real &  beta 
)
inline

General CreateGaugeState<P,Q>

Definition at line 34 of file wilson_gaugeact.h.

References Chroma::WilsonGaugeActParams::beta, Chroma::StagPhases::beta(), init(), and param.

◆ WilsonGaugeAct() [2/4]

Chroma::WilsonGaugeAct::WilsonGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const Real &  beta,
const AnisoParam_t aniso 
)
inline

General CreateGaugeState<P,Q>

Definition at line 39 of file wilson_gaugeact.h.

References Chroma::WilsonGaugeActParams::aniso, Chroma::WilsonGaugeActParams::beta, Chroma::StagPhases::beta(), init(), and param.

◆ WilsonGaugeAct() [3/4]

Chroma::WilsonGaugeAct::WilsonGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const WilsonGaugeActParams p 
)
inline

Read beta from a param struct.

Definition at line 45 of file wilson_gaugeact.h.

References init().

◆ ~WilsonGaugeAct()

Chroma::WilsonGaugeAct::~WilsonGaugeAct ( )
inline

Destructor is automatic.

Definition at line 85 of file wilson_gaugeact.h.

◆ WilsonGaugeAct() [4/4]

Chroma::WilsonGaugeAct::WilsonGaugeAct ( )
inlineprotected

Partial constructor.

Definition at line 98 of file wilson_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

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

Anisotropy factor.

Definition at line 53 of file wilson_gaugeact.h.

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

◆ anisoP()

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

Is anisotropy used?

Definition at line 50 of file wilson_gaugeact.h.

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

◆ deriv()

void Chroma::WilsonGaugeAct::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 72 of file wilson_gaugeact.h.

References plaq, and Chroma::state.

◆ getBeta()

const Real Chroma::WilsonGaugeAct::getBeta ( void  ) const
inline

Definition at line 88 of file wilson_gaugeact.h.

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

◆ getCreateState()

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

Produce a gauge create state object.

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

Definition at line 91 of file wilson_gaugeact.h.

References plaq.

◆ getSet()

const Set& Chroma::WilsonGaugeAct::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 60 of file wilson_gaugeact.h.

◆ init()

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

◆ operator=()

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

Hide assignment.

Definition at line 100 of file wilson_gaugeact.h.

◆ S()

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

Compute the actions.

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

Definition at line 79 of file wilson_gaugeact.h.

References plaq, and Chroma::state.

◆ staple()

void Chroma::WilsonGaugeAct::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 64 of file wilson_gaugeact.h.

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

◆ tDir()

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

Anisotropic direction.

Definition at line 56 of file wilson_gaugeact.h.

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

Member Data Documentation

◆ param

WilsonGaugeActParams Chroma::WilsonGaugeAct::param
private

Definition at line 104 of file wilson_gaugeact.h.

Referenced by anisoFactor(), anisoP(), getBeta(), init(), tDir(), and WilsonGaugeAct().

◆ plaq

Handle<PlaqGaugeAct> Chroma::WilsonGaugeAct::plaq
private

Definition at line 103 of file wilson_gaugeact.h.

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


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