CHROMA
Public Member Functions | List of all members
Chroma::GaugeAction< P, Q > Class Template Referenceabstract

Abstract base class for gauge actions. More...

#include <gaugeact.h>

Public Member Functions

virtual ~GaugeAction ()
 Virtual destructor to help with cleanup;. More...
 
virtual const CreateGaugeState< P, Q > & getCreateState () const =0
 Return the factory object that produces a state. More...
 
virtual GaugeState< P, Q > * createState (const Q &q) const
 Given links, create the state. More...
 
virtual const GaugeBC< P, Q > & getGaugeBC () const
 Return the gauge BC object for this action. More...
 
virtual const Set & getSet (void) const =0
 Return the set on which the gauge action is defined. More...
 
virtual void deriv (P &result, const Handle< GaugeState< P, Q > > &state) const
 Compute dS/dU. More...
 
virtual Double S (const Handle< GaugeState< P, Q > > &state) const =0
 Compute the action on a gauge configuration. More...
 

Detailed Description

template<typename P, typename Q>
class Chroma::GaugeAction< P, Q >

Abstract base class for gauge actions.

Supports creation and application for gauge actions

Definition at line 24 of file gaugeact.h.

Constructor & Destructor Documentation

◆ ~GaugeAction()

template<typename P , typename Q >
virtual Chroma::GaugeAction< P, Q >::~GaugeAction ( )
inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 28 of file gaugeact.h.

Member Function Documentation

◆ createState()

template<typename P , typename Q >
virtual GaugeState<P,Q>* Chroma::GaugeAction< P, Q >::createState ( const Q q) const
inlinevirtual

Given links, create the state.

Definition at line 40 of file gaugeact.h.

References Chroma::GaugeAction< P, Q >::getCreateState(), and q.

Referenced by main(), and Chroma::mciter().

◆ deriv()

template<typename P , typename Q >
virtual void Chroma::GaugeAction< P, Q >::deriv ( P result,
const Handle< GaugeState< P, Q > > &  state 
) const
inlinevirtual

◆ getCreateState()

template<typename P , typename Q >
virtual const CreateGaugeState<P,Q>& Chroma::GaugeAction< P, Q >::getCreateState ( ) const
pure virtual

◆ getGaugeBC()

template<typename P , typename Q >
virtual const GaugeBC<P,Q>& Chroma::GaugeAction< P, Q >::getGaugeBC ( ) const
inlinevirtual

Return the gauge BC object for this action.

Definition at line 46 of file gaugeact.h.

References Chroma::GaugeAction< P, Q >::getCreateState().

Referenced by Chroma::mciter().

◆ getSet()

template<typename P , typename Q >
virtual const Set& Chroma::GaugeAction< P, Q >::getSet ( void  ) const
pure virtual

◆ S()

template<typename P , typename Q >
virtual Double Chroma::GaugeAction< P, Q >::S ( const Handle< GaugeState< P, Q > > &  state) const
pure virtual

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