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

RG gauge action. More...

#include <rbc_gaugeact.h>

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

Public Member Functions

 RBCGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const Real &beta_, const Real &c1_)
 General CreateGaugeState<P,Q> More...
 
 RBCGaugeAct (Handle< CreateGaugeState< P, Q > > cgs_, const RBCGaugeActParams &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...
 
 ~RBCGaugeAct ()
 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...
 
 RBCGaugeAct ()
 Partial constructor. More...
 
void operator= (const RBCGaugeAct &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 following RBC conventions

S = -(beta/Nc)*[(1-8*c_1)*Plaq + c_1 * Rect]

Definition at line 49 of file rbc_gaugeact.h.

Constructor & Destructor Documentation

◆ RBCGaugeAct() [1/3]

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

General CreateGaugeState<P,Q>

Definition at line 53 of file rbc_gaugeact.h.

References init().

◆ RBCGaugeAct() [2/3]

Chroma::RBCGaugeAct::RBCGaugeAct ( Handle< CreateGaugeState< P, Q > >  cgs_,
const RBCGaugeActParams p 
)
inline

Read beta from a param struct.

Definition at line 58 of file rbc_gaugeact.h.

References init().

◆ ~RBCGaugeAct()

Chroma::RBCGaugeAct::~RBCGaugeAct ( )
inline

Destructor is automatic.

Definition at line 109 of file rbc_gaugeact.h.

◆ RBCGaugeAct() [3/3]

Chroma::RBCGaugeAct::RBCGaugeAct ( )
inlineprotected

Partial constructor.

Definition at line 119 of file rbc_gaugeact.h.

Member Function Documentation

◆ anisoFactor()

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

Anisotropy factor.

Definition at line 66 of file rbc_gaugeact.h.

◆ anisoP()

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

Is anisotropy used?

Definition at line 63 of file rbc_gaugeact.h.

◆ deriv()

void Chroma::RBCGaugeAct::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 89 of file rbc_gaugeact.h.

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

◆ getBeta()

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

Definition at line 112 of file rbc_gaugeact.h.

References beta.

◆ getCreateState()

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

Produce a gauge create state object.

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

Definition at line 106 of file rbc_gaugeact.h.

References plaq.

◆ getSet()

const Set& Chroma::RBCGaugeAct::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 73 of file rbc_gaugeact.h.

◆ init()

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

Private initializer.

Definition at line 62 of file rbc_gaugeact.cc.

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

Referenced by RBCGaugeAct().

◆ operator=()

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

Hide assignment.

Definition at line 121 of file rbc_gaugeact.h.

◆ S()

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

Compute the actions.

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

Definition at line 100 of file rbc_gaugeact.h.

References plaq, rect, and Chroma::state.

◆ staple()

void Chroma::RBCGaugeAct::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 77 of file rbc_gaugeact.h.

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

◆ tDir()

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

Anisotropic direction.

Definition at line 69 of file rbc_gaugeact.h.

References Nd.

Member Data Documentation

◆ beta

Real Chroma::RBCGaugeAct::beta
private

Definition at line 124 of file rbc_gaugeact.h.

Referenced by getBeta(), and init().

◆ c1

Real Chroma::RBCGaugeAct::c1
private

Definition at line 125 of file rbc_gaugeact.h.

Referenced by init().

◆ plaq

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

Definition at line 126 of file rbc_gaugeact.h.

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

◆ rect

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

Definition at line 127 of file rbc_gaugeact.h.

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


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