Staggered fermion action. More...

#include <stag_fermact_s.h>

Inheritance diagram for Chroma::StagFermAct:

Public Types
typedef LatticeStaggeredFermion	T

typedef multi1d< LatticeColorMatrix >	P

typedef multi1d< LatticeColorMatrix >	Q

Public Member Functions
	StagFermAct (Handle< FermBC< T, P, Q > > fbc_, const Real &Mass_)
	General FermBC. More...

	StagFermAct (const StagFermAct &a)
	Copy constructor. More...

StagFermAct &	operator= (const StagFermAct &a)
	Assignment. More...

const Real	getQuarkMass () const
	Return the quark mass. More...

EvenOddLinearOperator< T, P, Q > *	linOp (Handle< FermState< T, P, Q > > state) const
	Produce a linear operator for this action. More...

DiffLinearOperator< T, P, Q > *	lMdagM (Handle< FermState< T, P, Q > > state) const
	Produce a linear operator M^dag.M for this action. More...

	~StagFermAct ()
	Destructor is automatic. More...

Public Member Functions inherited from Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >
virtual	~EvenOddStaggeredTypeFermAct ()
	Virtual destructor to help with cleanup;. More...

virtual	~EvenOddStaggeredTypeFermAct ()
	Virtual destructor to help with cleanup;. More...

virtual SystemSolver< LatticeStaggeredFermion > *	qprop (Handle< FermState< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const
	Return quark prop solver, solution of unpreconditioned system. More...

virtual SystemSolver< LatticeStaggeredFermion > *	qprop (Handle< FermState< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const
	Return quark prop solver, solution of unpreconditioned system. More...

SystemSolver< LF > *	qprop (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve MdagM*psi=chi. More...

Public Member Functions inherited from Chroma::StaggeredTypeFermAct< T, P, Q >
virtual	~StaggeredTypeFermAct ()
	Virtual destructor to help with cleanup;. More...

virtual LinOpSystemSolver< T > *	invLinOp (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve M*psi=chi. More...

virtual MdagMSystemSolver< T > *	invMdagM (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve MdagM*psi=chi. More...

virtual MdagMMultiSystemSolver< T > *	mInvMdagM (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi. More...

virtual void	quarkProp (typename PropTypeTraits< T >::Type_t &q_sol, XMLWriter &xml_out, const typename PropTypeTraits< T >::Type_t &q_src, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, int &ncg_had) const
	Given a complete propagator as a source, this does all the inversions needed. More...

virtual	~StaggeredTypeFermAct ()
	Virtual destructor to help with cleanup;. More...

virtual LinOpSystemSolver< T > *	invLinOp (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve M*psi=chi. More...

virtual MdagMSystemSolver< T > *	invMdagM (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve MdagM*psi=chi. More...

virtual LinOpMultiSystemSolver< T > *	mInvLinOp (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (M+shift)*psi=chi. More...

virtual MdagMMultiSystemSolver< T > *	mInvMdagM (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi. More...

virtual MdagMMultiSystemSolverAccumulate< T > *	mInvMdagMAcc (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi. More...

virtual void	quarkProp (typename PropTypeTraits< T >::Type_t &q_sol, XMLWriter &xml_out, const typename PropTypeTraits< T >::Type_t &q_src, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, int &ncg_had) const
	Given a complete propagator as a source, this does all the inversions needed. More...

void	quarkProp (LatticeStaggeredPropagator &q_sol, XMLWriter &xml_out, const LatticeStaggeredPropagator &q_src, Handle< FermState< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, int &ncg_had) const
	Given a complete propagator as a source, this does all the inversions needed. More...

LinOpSystemSolver< LF > *	invLinOp (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const

MdagMSystemSolver< LF > *	invMdagM (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve MdagM*psi=chi. More...

LinOpMultiSystemSolver< LF > *	mInvLinOp (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve (M+shift_i)*psi_i = chi. More...

MdagMMultiSystemSolver< LF > *	mInvMdagM (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve (MdagM+shift_i)*psi_i = chi. More...

MdagMMultiSystemSolverAccumulate< LF > *	mInvMdagMAcc (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve (MdagM+shift_i)*psi_i = chi. More...

Public Member Functions inherited from Chroma::DiffFermAct4D< T, P, Q >
virtual	~DiffFermAct4D ()
	Virtual destructor to help with cleanup;. More...

virtual DiffLinearOperator< T, Q, P > *	linOp (Handle< FermState< T, P, Q > > state) const =0
	Produce a linear operator for this action. More...

virtual DiffLinearOperator< T, Q, P > *	lMdagM (Handle< FermState< T, P, Q > > state) const =0
	Produce a linear operator M^dag.M for this action. More...

virtual	~DiffFermAct4D ()
	Virtual destructor to help with cleanup;. More...

virtual DiffLinearOperator< T, Q, P > *	linOp (Handle< FermState< T, P, Q > > state) const =0
	Produce a linear operator for this action. More...

virtual DiffLinearOperator< T, Q, P > *	lMdagM (Handle< FermState< T, P, Q > > state) const =0
	Produce a linear operator M^dag.M for this action. More...

Public Member Functions inherited from Chroma::FermAct4D< T, P, Q >
virtual	~FermAct4D ()
	Virtual destructor to help with cleanup;. More...

virtual SystemSolver< T > *	qprop (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return quark prop solver, solution of unpreconditioned system. More...

virtual	~FermAct4D ()
	Virtual destructor to help with cleanup;. More...

virtual SystemSolver< T > *	qprop (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return quark prop solver, solution of unpreconditioned system. More...

SystemSolver< LatticeFermion > *	qprop (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const
	Return quark prop solver, solution of unpreconditioned system. More...

SystemSolver< LatticeStaggeredFermion > *	qprop (Handle< FermState< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const

Public Member Functions inherited from Chroma::FermionAction< T, P, Q >
virtual	~FermionAction ()
	Virtual destructor to help with cleanup;. More...

virtual FermState< T, P, Q > *	createState (const Q &q) const
	Given links (coordinates Q) create the state needed for the linear operators. More...

virtual FermState< T, P, Q > *	createState (const Q &q, XMLReader &reader, const std::string &path) const
	Given links (coordinates Q) create a state with additional info held by the XMLReader. More...

virtual const FermBC< T, P, Q > &	getFermBC () const
	Return the fermion BC object for this action. More...

virtual void	quarkProp (typename PropTypeTraits< T >::Type_t &q_sol, XMLWriter &xml_out, const typename PropTypeTraits< T >::Type_t &q_src, int t_src, int j_decay, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, bool obsvP, int &ncg_had) const
	Given a complete propagator as a source, this does all the inversions needed. More...

virtual	~FermionAction ()
	Virtual destructor to help with cleanup;. More...

virtual FermState< T, P, Q > *	createState (const Q &q) const
	Given links (coordinates Q) create the state needed for the linear operators. More...

virtual FermState< T, P, Q > *	createState (const Q &q, XMLReader &reader, const std::string &path) const
	Given links (coordinates Q) create a state with additional info held by the XMLReader. More...

virtual const FermBC< T, P, Q > &	getFermBC () const
	Return the fermion BC object for this action. More...

virtual void	quarkProp (typename PropTypeTraits< T >::Type_t &q_sol, XMLWriter &xml_out, const typename PropTypeTraits< T >::Type_t &q_src, int t_src, int j_decay, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, bool obsvP, int &ncg_had) const
	Given a complete propagator as a source, this does all the inversions needed. More...

Protected Member Functions
const CreateFermState< T, P, Q > &	getCreateState () const
	Return the fermion BC object for this action. More...

Private Member Functions
	StagFermAct ()

Private Attributes
Handle< FermBC< T, P, Q > >	fbc

Real	Mass

Detailed Description

Staggered fermion action.

Definition at line 18 of file stag_fermact_s.h.

Member Typedef Documentation

◆ P

typedef multi1d<LatticeColorMatrix> Chroma::StagFermAct::P

Definition at line 24 of file stag_fermact_s.h.

◆ Q

typedef multi1d<LatticeColorMatrix> Chroma::StagFermAct::Q

Definition at line 25 of file stag_fermact_s.h.

◆ T

typedef LatticeStaggeredFermion Chroma::StagFermAct::T

Definition at line 23 of file stag_fermact_s.h.

Constructor & Destructor Documentation

◆ StagFermAct() [1/3]

Chroma::StagFermAct::StagFermAct	(	Handle< FermBC< T, P, Q > >	fbc_,
		const Real &	Mass_
	)

inline

General FermBC.

Definition at line 28 of file stag_fermact_s.h.

◆ StagFermAct() [2/3]

Chroma::StagFermAct::StagFermAct ( const StagFermAct & a )

inline

Copy constructor.

Definition at line 33 of file stag_fermact_s.h.

◆ ~StagFermAct()

Chroma::StagFermAct::~StagFermAct ( )

inline

Destructor is automatic.

Definition at line 50 of file stag_fermact_s.h.

◆ StagFermAct() [3/3]

Chroma::StagFermAct::StagFermAct ( )

inlineprivate

Definition at line 57 of file stag_fermact_s.h.

Member Function Documentation

◆ getCreateState()

const CreateFermState<T,P,Q>& Chroma::StagFermAct::getCreateState ( ) const

inlineprotectedvirtual

Return the fermion BC object for this action.

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

Definition at line 54 of file stag_fermact_s.h.

◆ getQuarkMass()

const Real Chroma::StagFermAct::getQuarkMass ( void ) const

inlinevirtual

Return the quark mass.

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

Definition at line 41 of file stag_fermact_s.h.

References Mass.

◆ linOp()

EvenOddLinearOperator<T,P,Q>* Chroma::StagFermAct::linOp ( Handle< FermState< T, P, Q > > state ) const

virtual

Produce a linear operator for this action.

Implements Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

◆ lMdagM()

DiffLinearOperator<T,P,Q>* Chroma::StagFermAct::lMdagM ( Handle< FermState< T, P, Q > > state ) const

Produce a linear operator M^dag.M for this action.

◆ operator=()

StagFermAct& Chroma::StagFermAct::operator= ( const StagFermAct & a )

inline

Assignment.

Definition at line 37 of file stag_fermact_s.h.

References Chroma::a, fbc, and Mass.

Member Data Documentation

◆ fbc

Handle< FermBC<T,P,Q> > Chroma::StagFermAct::fbc

private

Definition at line 60 of file stag_fermact_s.h.

Referenced by operator=().

◆ Mass

Real Chroma::StagFermAct::Mass

private

Definition at line 61 of file stag_fermact_s.h.

Referenced by getQuarkMass(), and operator=().

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

stag_fermact_s.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ P

◆ Q

◆ T

Constructor & Destructor Documentation

◆ StagFermAct() [1/3]

◆ StagFermAct() [2/3]

◆ ~StagFermAct()

◆ StagFermAct() [3/3]

Member Function Documentation

◆ getCreateState()

◆ getQuarkMass()

◆ linOp()

◆ lMdagM()

◆ operator=()

Member Data Documentation

◆ fbc

◆ Mass