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

Create a fermion connection state. More...

#include <create_state.h>

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

Public Member Functions
virtual	~CreateFermState ()
	Virtual destructor to help with cleanup;. More...
virtual FermState< T, P, Q > *	operator() (const Q &q) const =0
	Construct a ConnectState. More...
virtual const FermBC< T, P, Q > &	getBC () const =0
	Return the gauge BC object for this state. More...
virtual Handle< FermBC< T, P, Q > >	getFermBC () const =0
	Return the gauge BC object for this state. More...
Public Member Functions inherited from Chroma::CreateState< P, Q >
virtual	~CreateState ()
	Virtual destructor to help with cleanup;. More...

Detailed Description

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

Create a fermion connection state.

This is a factory class for producing a connection state

Definition at line 68 of file create_state.h.

Constructor & Destructor Documentation

~CreateFermState()

template<typename T , typename P , typename Q >

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

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 72 of file create_state.h.

Member Function Documentation

getBC()

template<typename T , typename P , typename Q >

virtual const FermBC<T,P,Q>& Chroma::CreateFermState< T, 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::CreateState< P, Q >.

Implemented in Chroma::CreateSLICFermState< T, P, Q >, Chroma::CreateStoutFermState< T, P, Q >, Chroma::CreateSimpleFermState< T, P, Q >, Chroma::CreatePeriodicFermState< T, P, Q >, Chroma::CreateHexFermState< T, P, Q >, Chroma::CreateExtFieldFermState< T, P, Q >, and Chroma::CreateEigenConnectState.

getFermBC()

template<typename T , typename P , typename Q >

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

pure virtual

Return the gauge BC object for this state.

This is to help the optimized linops

Implemented in Chroma::CreateSLICFermState< T, P, Q >, Chroma::CreateStoutFermState< T, P, Q >, Chroma::CreateSimpleFermState< T, P, Q >, Chroma::CreatePeriodicFermState< T, P, Q >, Chroma::CreateHexFermState< T, P, Q >, and Chroma::CreateExtFieldFermState< T, P, Q >.

operator()()

template<typename T , typename P , typename Q >

virtual FermState<T,P,Q>* Chroma::CreateFermState< T, P, Q >::operator() ( const Q &  q ) const

pure virtual

Construct a ConnectState.

Implements Chroma::CreateState< P, Q >.

Implemented in Chroma::CreateSLICFermState< T, P, Q >, Chroma::CreateStoutFermState< T, P, Q >, Chroma::CreateSimpleFermState< T, P, Q >, Chroma::CreatePeriodicFermState< T, P, Q >, Chroma::CreateHexFermState< T, P, Q >, Chroma::CreateExtFieldFermState< T, P, Q >, and Chroma::CreateEigenConnectState.

---

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

• create_state.h