CHROMA
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Chroma::PeriodicGaugeState< P, Q > Class Template Reference

Periodic version of GaugeState. More...

#include <periodic_gaugestate.h>

Inheritance diagram for Chroma::PeriodicGaugeState< P, Q >:
Chroma::GaugeState< P, Q > Chroma::ConnectState< P, Q >

Public Member Functions

 PeriodicGaugeState (const Q &q_)
 Full constructor. More...
 
 ~PeriodicGaugeState ()
 Destructor. More...
 
const QgetLinks () const
 Return the link fields needed in constructing linear operators. More...
 
const GaugeBC< P, Q > & getBC () const
 Return the gauge BC object for this state. More...
 
Handle< GaugeBC< P, Q > > getGaugeBC () const
 Return the gauge BC object for this state. More...
 
- Public Member Functions inherited from Chroma::GaugeState< P, Q >
virtual ~GaugeState ()
 Virtual destructor to help with cleanup;. More...
 
- Public Member Functions inherited from Chroma::ConnectState< P, Q >
virtual ~ConnectState ()
 Virtual destructor to help with cleanup;. More...
 
virtual void deriv (P &F) const
 

Private Member Functions

 PeriodicGaugeState ()
 
void operator= (const PeriodicGaugeState< P, Q > &)
 

Private Attributes

Handle< GaugeBC< P, Q > > gbc
 
Q q
 

Detailed Description

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

Periodic version of GaugeState.

Only needs to hold a gauge field and gauge bc

Definition at line 32 of file periodic_gaugestate.h.

Constructor & Destructor Documentation

◆ PeriodicGaugeState() [1/2]

template<typename P , typename Q >
Chroma::PeriodicGaugeState< P, Q >::PeriodicGaugeState ( const Q q_)
inline

Full constructor.

Definition at line 36 of file periodic_gaugestate.h.

◆ ~PeriodicGaugeState()

template<typename P , typename Q >
Chroma::PeriodicGaugeState< P, Q >::~PeriodicGaugeState ( )
inline

Destructor.

Definition at line 40 of file periodic_gaugestate.h.

◆ PeriodicGaugeState() [2/2]

template<typename P , typename Q >
Chroma::PeriodicGaugeState< P, Q >::PeriodicGaugeState ( )
inlineprivate

Definition at line 52 of file periodic_gaugestate.h.

Member Function Documentation

◆ getBC()

template<typename P , typename Q >
const GaugeBC<P,Q>& Chroma::PeriodicGaugeState< P, Q >::getBC ( ) const
inlinevirtual

Return the gauge BC object for this state.

Implements Chroma::GaugeState< P, Q >.

Definition at line 46 of file periodic_gaugestate.h.

References Chroma::PeriodicGaugeState< P, Q >::gbc.

◆ getGaugeBC()

template<typename P , typename Q >
Handle< GaugeBC<P,Q> > Chroma::PeriodicGaugeState< P, Q >::getGaugeBC ( ) const
inline

Return the gauge BC object for this state.

Definition at line 49 of file periodic_gaugestate.h.

References Chroma::PeriodicGaugeState< P, Q >::gbc.

◆ getLinks()

template<typename P , typename Q >
const Q& Chroma::PeriodicGaugeState< P, Q >::getLinks ( ) const
inlinevirtual

Return the link fields needed in constructing linear operators.

Implements Chroma::ConnectState< P, Q >.

Definition at line 43 of file periodic_gaugestate.h.

References Chroma::PeriodicGaugeState< P, Q >::q.

◆ operator=()

template<typename P , typename Q >
void Chroma::PeriodicGaugeState< P, Q >::operator= ( const PeriodicGaugeState< P, Q > &  )
inlineprivate

Definition at line 53 of file periodic_gaugestate.h.

Member Data Documentation

◆ gbc

template<typename P , typename Q >
Handle< GaugeBC<P,Q> > Chroma::PeriodicGaugeState< P, Q >::gbc
private

◆ q

template<typename P , typename Q >
Q Chroma::PeriodicGaugeState< P, Q >::q
private

Definition at line 57 of file periodic_gaugestate.h.

Referenced by Chroma::PeriodicGaugeState< P, Q >::getLinks().


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