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

Stout field state. More...

#include <stout_fermstate_w.h>

Inheritance diagram for Chroma::StoutFermState< T, P, Q >:
Chroma::FermState< T, P, Q > Chroma::ConnectState< P, Q > Chroma::SLICFermState< T, P, Q >

Public Member Functions

 StoutFermState (Handle< FermBC< T, P, Q > > fbc_, const StoutFermStateParams &p_, const Q &u_)
 Constructor only from a parameter structure. More...
 
const FermBC< T, P, Q > & getBC () const
 Return the ferm BC object for this state. More...
 
Handle< FermBC< T, P, Q > > getFermBC () const
 Return the ferm BC object for this state. More...
 
virtual ~StoutFermState ()
 Destructor is automagic. More...
 
const QgetLinks () const
 Return FAT Linke. More...
 
const QgetThinLinks () const
 
void fatForceToThin (const P &F_fat, P &F_thin) const
 
virtual void deriv (P &F) const
 
- Public Member Functions inherited from Chroma::FermState< T, P, Q >
virtual ~FermState ()
 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...
 

Private Member Functions

 StoutFermState ()
 
void create (Handle< FermBC< T, P, Q > > fbc_, const StoutFermStateParams &p_, const Q &u_)
 

Private Attributes

Handle< FermBC< T, P, Q > > fbc
 
multi1d< Qsmeared_links
 
Q fat_links_with_bc
 
StoutFermStateParams params
 

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::StoutFermState< T, P, Q >

Stout field state.

Holds a stout smeared state

Definition at line 34 of file stout_fermstate_w.h.

Constructor & Destructor Documentation

◆ StoutFermState() [1/2]

template<typename T , typename P , typename Q >
Chroma::StoutFermState< T, P, Q >::StoutFermState ( Handle< FermBC< T, P, Q > >  fbc_,
const StoutFermStateParams p_,
const Q u_ 
)
inline

Constructor only from a parameter structure.

Definition at line 40 of file stout_fermstate_w.h.

References Chroma::StoutFermState< T, P, Q >::create(), Chroma::END_CODE(), and Chroma::START_CODE().

◆ ~StoutFermState()

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

Destructor is automagic.

Definition at line 56 of file stout_fermstate_w.h.

◆ StoutFermState() [2/2]

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

Definition at line 133 of file stout_fermstate_w.h.

Member Function Documentation

◆ create()

template<typename T , typename P , typename Q >
void Chroma::StoutFermState< T, P, Q >::create ( Handle< FermBC< T, P, Q > >  fbc_,
const StoutFermStateParams p_,
const Q u_ 
)
inlineprivate

◆ deriv()

template<typename T , typename P , typename Q >
virtual void Chroma::StoutFermState< T, P, Q >::deriv ( P F) const
inlinevirtual

A virtual function to get the derivative of the state. This is useful for things like fat link states, where the derivative of the state with respect to the thin links is complicated. The default implementation just multiplies the accumulated force by the (thin) links, which works because $\dot{U} = \pi U$ and the pi momenta get factored out this function modifies the force term

Reimplemented from Chroma::ConnectState< P, Q >.

Reimplemented in Chroma::SLICFermState< T, P, Q >.

Definition at line 110 of file stout_fermstate_w.h.

References Chroma::END_CODE(), F, Chroma::StoutFermState< T, P, Q >::fatForceToThin(), mu, Nd, Chroma::StoutFermState< T, P, Q >::smeared_links, and Chroma::START_CODE().

◆ fatForceToThin()

template<typename T , typename P , typename Q >
void Chroma::StoutFermState< T, P, Q >::fatForceToThin ( const P F_fat,
P F_thin 
) const
inline

◆ getBC()

template<typename T , typename P , typename Q >
const FermBC<T,P,Q>& Chroma::StoutFermState< T, P, Q >::getBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::FermState< T, P, Q >.

Definition at line 50 of file stout_fermstate_w.h.

References Chroma::StoutFermState< T, P, Q >::fbc.

◆ getFermBC()

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::StoutFermState< T, P, Q >::getFermBC ( ) const
inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::FermState< T, P, Q >.

Definition at line 53 of file stout_fermstate_w.h.

References Chroma::StoutFermState< T, P, Q >::fbc.

◆ getLinks()

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

Return FAT Linke.

Implements Chroma::ConnectState< P, Q >.

Definition at line 59 of file stout_fermstate_w.h.

References Chroma::StoutFermState< T, P, Q >::fat_links_with_bc.

◆ getThinLinks()

template<typename T , typename P , typename Q >
const Q& Chroma::StoutFermState< T, P, Q >::getThinLinks ( ) const
inline

Member Data Documentation

◆ fat_links_with_bc

template<typename T , typename P , typename Q >
Q Chroma::StoutFermState< T, P, Q >::fat_links_with_bc
private

◆ fbc

template<typename T , typename P , typename Q >
Handle< FermBC<T,P,Q> > Chroma::StoutFermState< T, P, Q >::fbc
private

◆ params

template<typename T , typename P , typename Q >
StoutFermStateParams Chroma::StoutFermState< T, P, Q >::params
private

◆ smeared_links

template<typename T , typename P , typename Q >
multi1d< Q > Chroma::StoutFermState< T, P, Q >::smeared_links
private

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