Staggered-like fermion actions. More...

#include <fermact.orig.h>

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

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

virtual const Real	getQuarkMass () const =0
	Return the quark mass. 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 const Real	getQuarkMass () const =0
	Return the quark mass. 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 const CreateFermState< T, P, Q > &	getCreateState () const =0
	Return the factory object that produces a state. 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 const CreateFermState< T, P, Q > &	getCreateState () const =0
	Return the factory object that produces a state. 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...

Detailed Description

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

Staggered-like fermion actions.

Staggered-like fermion actions

Definition at line 643 of file fermact.orig.h.

Constructor & Destructor Documentation

◆ ~StaggeredTypeFermAct() [1/2]

template<typename T , typename P , typename Q >

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

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 647 of file fermact.orig.h.

◆ ~StaggeredTypeFermAct() [2/2]

template<typename T , typename P , typename Q >

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

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 27 of file stagtype_fermact_s.h.

Member Function Documentation

◆ getQuarkMass() [1/2]

template<typename T , typename P , typename Q >

virtual const Real Chroma::StaggeredTypeFermAct< T, P, Q >::getQuarkMass ( ) const

pure virtual

Return the quark mass.

Implemented in Chroma::StagFermAct, Chroma::KleinGordonFermAct, Chroma::HisqFermAct, and Chroma::AsqtadFermAct.

Referenced by Chroma::InlineStaggeredSpectrum::func(), and main().

◆ getQuarkMass() [2/2]

template<typename T , typename P , typename Q >

virtual const Real Chroma::StaggeredTypeFermAct< T, P, Q >::getQuarkMass ( ) const

pure virtual

Return the quark mass.

Implemented in Chroma::StagFermAct, Chroma::KleinGordonFermAct, Chroma::HisqFermAct, and Chroma::AsqtadFermAct.

◆ invLinOp() [1/3]

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

Definition at line 180 of file quarkprop4_s.cc.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::GroupXML_t::path, Chroma::state, and Chroma::GroupXML_t::xml.

◆ invLinOp() [2/3]

template<typename T , typename P , typename Q >

virtual LinOpSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::invLinOp	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a linear operator solver for this action to solve M*psi=chi.

Default implementation provided

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

◆ invLinOp() [3/3]

template<typename T , typename P , typename Q >

virtual LinOpSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::invLinOp	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a linear operator solver for this action to solve M*psi=chi.

Default implementation provided

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

◆ invMdagM() [1/3]

MdagMSystemSolver< LF > * Chroma::StaggeredTypeFermAct< LF, LCM, LCM >::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.

Definition at line 198 of file quarkprop4_s.cc.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::GroupXML_t::path, Chroma::state, and Chroma::GroupXML_t::xml.

◆ invMdagM() [2/3]

template<typename T , typename P , typename Q >

virtual MdagMSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::invMdagM	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a linear operator solver for this action to solve MdagM*psi=chi.

Default implementation provided

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

◆ invMdagM() [3/3]

template<typename T , typename P , typename Q >

virtual MdagMSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::invMdagM	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a linear operator solver for this action to solve MdagM*psi=chi.

Default implementation provided

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

◆ mInvLinOp() [1/2]

LinOpMultiSystemSolver< LF > * Chroma::StaggeredTypeFermAct< LF, LCM, LCM >::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.

Definition at line 216 of file quarkprop4_s.cc.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::GroupXML_t::path, Chroma::state, and Chroma::GroupXML_t::xml.

◆ mInvLinOp() [2/2]

template<typename T , typename P , typename Q >

virtual LinOpMultiSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::mInvLinOp	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a multi-shift linear operator solver for this action to solve (M+shift)*psi=chi.

Default implementation

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

◆ mInvMdagM() [1/3]

MdagMMultiSystemSolver< LF > * Chroma::StaggeredTypeFermAct< LF, LCM, LCM >::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.

Definition at line 233 of file quarkprop4_s.cc.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::GroupXML_t::path, Chroma::state, and Chroma::GroupXML_t::xml.

◆ mInvMdagM() [2/3]

template<typename T , typename P , typename Q >

virtual MdagMMultiSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::mInvMdagM	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi.

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

◆ mInvMdagM() [3/3]

template<typename T , typename P , typename Q >

virtual MdagMMultiSystemSolver<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::mInvMdagM	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi.

Default implementation

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

◆ mInvMdagMAcc() [1/2]

MdagMMultiSystemSolverAccumulate< LF > * Chroma::StaggeredTypeFermAct< LF, LCM, LCM >::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.

Definition at line 250 of file quarkprop4_s.cc.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::GroupXML_t::path, Chroma::state, and Chroma::GroupXML_t::xml.

◆ mInvMdagMAcc() [2/2]

template<typename T , typename P , typename Q >

virtual MdagMMultiSystemSolverAccumulate<T>* Chroma::StaggeredTypeFermAct< T, P, Q >::mInvMdagMAcc	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

virtual

Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi.

Default implementation

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

◆ quarkProp() [1/3]

void Chroma::StaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >::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.

This routine is actually generic to all Staggered-like fermions

Parameters

q_sol	quark propagator ( Write )
q_src	source ( Read )
invParam	inverter parameters ( Read )
ncg_had	number of CG iterations ( Write )

Definition at line 158 of file quarkprop4_s.cc.

References Chroma::quarkProp4(), and Chroma::state.

◆ quarkProp() [2/3]

template<typename T , typename P , typename Q >

virtual void Chroma::StaggeredTypeFermAct< T, P, Q >::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

virtual

Given a complete propagator as a source, this does all the inversions needed.

Provides a default version

Parameters

q_sol	quark propagator ( Write )
q_src	source ( Read )
xml_out	diagnostic output ( Modify )
state	gauge connection state ( Read )
invParam	inverter parameters ( Read )
quarkSpinType	compute only a non-relativistic prop ( Read )
ncg_had	number of solver iterations ( Write )

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

◆ quarkProp() [3/3]

template<typename T , typename P , typename Q >

virtual void Chroma::StaggeredTypeFermAct< T, P, Q >::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

virtual

Given a complete propagator as a source, this does all the inversions needed.

Provides a default version

Parameters

q_sol	quark propagator ( Write )
q_src	source ( Read )
xml_out	diagnostic output ( Modify )
state	gauge connection state ( Read )
invParam	inverter parameters ( Read )
quarkSpinType	compute only a non-relativistic prop ( Read )
ncg_had	number of solver iterations ( Write )

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

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

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ ~StaggeredTypeFermAct() [1/2]

◆ ~StaggeredTypeFermAct() [2/2]

Member Function Documentation

◆ getQuarkMass() [1/2]

◆ getQuarkMass() [2/2]

◆ invLinOp() [1/3]

◆ invLinOp() [2/3]

◆ invLinOp() [3/3]

◆ invMdagM() [1/3]

◆ invMdagM() [2/3]

◆ invMdagM() [3/3]

◆ mInvLinOp() [1/2]

◆ mInvLinOp() [2/2]

◆ mInvMdagM() [1/3]

◆ mInvMdagM() [2/3]

◆ mInvMdagM() [3/3]

◆ mInvMdagMAcc() [1/2]

◆ mInvMdagMAcc() [2/2]

◆ quarkProp() [1/3]

◆ quarkProp() [2/3]

◆ quarkProp() [3/3]

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