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

Support class for fermion actions and linear operators. More...

#include <state.h>

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

Public Member Functions

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

Detailed Description

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

Support class for fermion actions and linear operators.

Holds things like color link fields and other info needed for linear operators.

Definition at line 73 of file state.h.

Constructor & Destructor Documentation

◆ ~GaugeState()

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

Virtual destructor to help with cleanup;.

Definition at line 77 of file state.h.

Member Function Documentation

◆ getBC()

template<typename P , typename Q >
virtual const GaugeBC<P,Q>& Chroma::GaugeState< P, Q >::getBC ( ) const
pure virtual

Return the gauge BC object for this state.

The user will supply the BC in a derived class

Implements Chroma::ConnectState< P, Q >.

Implemented in Chroma::StoutGaugeState< P, Q >, Chroma::SimpleGaugeState< P, Q >, and Chroma::PeriodicGaugeState< P, Q >.


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