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

RG gauge action. More...

#include <rg_gaugeact.h>

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

Public Member Functions

 RGGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &beta_, const Real &c1_)
 General CreateGaugeState<P,Q> More...
 
 RGGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const RGGaugeActParams &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...
 
 ~RGGaugeAct ()
 Destructor is automatic. More...
 
const Real getBeta (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 (Handle< CreateGaugeState< P, Q > > cgs)
 Private initializer. More...
 
 RGGaugeAct ()
 Partial constructor. More...
 
void operator= (const RGGaugeAct &a)
 Hide assignment. More...
 

Private Attributes

Real beta
 
Real c1
 
Handle< PlaqGaugeActplaq
 
Handle< RectGaugeActrect
 

Additional Inherited Members

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

Detailed Description

RG gauge action.

A RG (plaquette + rectangle) gauge action

Definition at line 47 of file rg_gaugeact.h.

Constructor & Destructor Documentation

◆ RGGaugeAct() [1/3]

Chroma::RGGaugeAct::RGGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const Real &  beta_,
const Real &  c1_ 
)
inline

General CreateGaugeState<P,Q>

Definition at line 51 of file rg_gaugeact.h.

References init().

◆ RGGaugeAct() [2/3]

Chroma::RGGaugeAct::RGGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const RGGaugeActParams p 
)
inline

Read beta from a param struct.

Definition at line 56 of file rg_gaugeact.h.

References init().

◆ ~RGGaugeAct()

Chroma::RGGaugeAct::~RGGaugeAct ( )
inline

Destructor is automatic.

Definition at line 107 of file rg_gaugeact.h.

◆ RGGaugeAct() [3/3]

Chroma::RGGaugeAct::RGGaugeAct ( )
inlineprotected

Partial constructor.

Definition at line 117 of file rg_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

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

Anisotropy factor.

Definition at line 64 of file rg_gaugeact.h.

◆ anisoP()

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

Is anisotropy used?

Definition at line 61 of file rg_gaugeact.h.

◆ deriv()

void Chroma::RGGaugeAct::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 87 of file rg_gaugeact.h.

References plaq, rect, Chroma::state, and Chroma::tmp.

◆ getBeta()

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

Definition at line 110 of file rg_gaugeact.h.

References beta.

◆ getCreateState()

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

Produce a gauge create state object.

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

Definition at line 104 of file rg_gaugeact.h.

References plaq.

◆ getSet()

const Set& Chroma::RGGaugeAct::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 71 of file rg_gaugeact.h.

◆ init()

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

Private initializer.

Definition at line 66 of file rg_gaugeact.cc.

References beta, c1, Chroma::END_CODE(), plaq, rect, and Chroma::START_CODE().

Referenced by RGGaugeAct().

◆ operator=()

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

Hide assignment.

Definition at line 119 of file rg_gaugeact.h.

◆ S()

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

Compute the actions.

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

Definition at line 98 of file rg_gaugeact.h.

References plaq, rect, and Chroma::state.

◆ staple()

void Chroma::RGGaugeAct::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 75 of file rg_gaugeact.h.

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

◆ tDir()

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

Anisotropic direction.

Definition at line 67 of file rg_gaugeact.h.

References Nd.

Member Data Documentation

◆ beta

Real Chroma::RGGaugeAct::beta
private

Definition at line 122 of file rg_gaugeact.h.

Referenced by getBeta(), and init().

◆ c1

Real Chroma::RGGaugeAct::c1
private

Definition at line 123 of file rg_gaugeact.h.

Referenced by init().

◆ plaq

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

Definition at line 124 of file rg_gaugeact.h.

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

◆ rect

Handle<RectGaugeAct> Chroma::RGGaugeAct::rect
private

Definition at line 125 of file rg_gaugeact.h.

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


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