Chroma::FermState< T, P, Q > Class Template Reference

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

#include <state.h>

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

Public Member Functions
virtual	~FermState ()
	Virtual destructor to help with cleanup;. More...
virtual const FermBC< T, P, Q > &	getBC () const =0
	Return the ferm BC object for this state. More...
virtual Handle< FermBC< T, P, Q > >	getFermBC () const =0
	Return the ferm 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 Q &	getLinks () const =0
	Return the coordinates (link fields) needed in constructing linear operators. More...
virtual void	deriv (P &F) const

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::FermState< T, 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 93 of file state.h.

Constructor & Destructor Documentation

~FermState()

template<typename T , typename P , typename Q >

virtual Chroma::FermState< T, P, Q >::~FermState ( )

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 97 of file state.h.

Member Function Documentation

getBC()

template<typename T , typename P , typename Q >

virtual const FermBC<T,P,Q>& Chroma::FermState< T, P, Q >::getBC ( ) const

pure virtual

Return the ferm BC object for this state.

The user will supply the BC in a derived class

Implements Chroma::ConnectState< P, Q >.

Implemented in Chroma::AsqtadConnectStateBase, Chroma::StoutFermState< T, P, Q >, Chroma::SimpleFermState< T, P, Q >, Chroma::PeriodicFermState< T, P, Q >, Chroma::OverlapConnectState, Chroma::HexFermState< T, P, Q >, Chroma::ExtFieldFermState< T, P, Q >, Chroma::EigenConnectState, and Chroma::AsqtadConnectState.

getFermBC()

template<typename T , typename P , typename Q >

virtual Handle< FermBC<T,P,Q> > Chroma::FermState< T, P, Q >::getFermBC ( ) const

pure virtual

Return the ferm BC object for this state.

This is to help the optimized linops

Implemented in Chroma::AsqtadConnectStateBase, Chroma::StoutFermState< T, P, Q >, Chroma::SimpleFermState< T, P, Q >, Chroma::PeriodicFermState< T, P, Q >, Chroma::OverlapConnectState, Chroma::HexFermState< T, P, Q >, Chroma::ExtFieldFermState< T, P, Q >, Chroma::EigenConnectState, and Chroma::AsqtadConnectState.

---

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

• state.h