EvenOddPreconditioned Extended-Overlap (N&N) linear operator. More...

#include <eoprec_ovext_fermact_array_w.h>

Inheritance diagram for Chroma::EvenOddPrecOvExtFermActArray:

Public Types
typedef LatticeFermion	T

typedef multi1d< LatticeColorMatrix >	P

typedef multi1d< LatticeColorMatrix >	Q

Public Member Functions
	EvenOddPrecOvExtFermActArray (Handle< CreateFermState< T, P, Q > > cfs_, const EvenOddPrecOvExtFermActArrayParams &param_)
	General FermBC. More...

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

int	size () const
	Length of DW flavor index/space. More...

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

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

EvenOddPrecConstDetLinearOperatorArray< T, P, Q > *	linOpPV (Handle< FermState< T, P, Q > > state) const
	Produce a Pauli-Villars linear operator for this action. More...

LinearOperatorArray< T > *	hermitianLinOp (Handle< FermState< T, P, Q > > state) const
	Produce a hermitian version of the linear operator. More...

LinearOperator< T > *	linOp4D (Handle< FermState< T, P, Q > > state, const Real &m_q, const GroupXML_t &invParam) const
	Produce an unpreconditioned linear operator projecting 5D to 4D (the inverse of qprop below) More...

LinearOperator< T > *	DeltaLs (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Produce a DeltaLs = 1-epsilon^2(H) operator. More...

SystemSolver< LatticeFermion > *	qprop (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Compute quark propagator over base type. More...

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

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

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

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

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

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

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

SystemSolverArray< LF > *	qpropT (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Propagator of a generic even-odd preconditioned fermion linear operator. More...

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

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

virtual LinOpSystemSolverArray< 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 MdagMSystemSolverArray< 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 LinOpSystemSolverArray< T > *	invLinOpPV (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve PV*psi=chi. More...

virtual MdagMSystemSolverArray< T > *	invMdagMPV (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve PV^dagPVpsi=chi. More...

virtual MdagMMultiSystemSolverArray< 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 MdagMMultiSystemSolverArray< T > *	mInvMdagMPV (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (PV^dagPV+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	~WilsonTypeFermAct5D ()
	Virtual destructor to help with cleanup;. More...

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

virtual LinOpSystemSolverArray< 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 MdagMSystemSolverArray< 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 LinOpSystemSolverArray< T > *	invLinOpPV (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve PV*psi=chi. More...

virtual MdagMSystemSolverArray< T > *	invMdagMPV (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve PV^dagPVpsi=chi. More...

virtual MdagMMultiSystemSolverArray< 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 MdagMMultiSystemSolverAccumulateArray< 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 MdagMMultiSystemSolverArray< T > *	mInvMdagMPV (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 MdagMMultiSystemSolverAccumulateArray< T > *	mInvMdagMPVAcc (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const
	Return a multi-shift linear operator solver for this action to solve (PV^dagPV+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 (LatticePropagator &q_sol, XMLWriter &xml_out, const LatticePropagator &q_src, Handle< FermState< LF, LCM, LCM > > 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...

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

MdagMSystemSolverArray< 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...

LinOpSystemSolverArray< LF > *	invLinOpPV (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const

MdagMSystemSolverArray< LF > *	invMdagMPV (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
	Return a linear operator solver for this action to solve PV^dagPVpsi=chi. More...

MdagMMultiSystemSolverArray< 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...

MdagMMultiSystemSolverAccumulateArray< 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...

MdagMMultiSystemSolverArray< LF > *	mInvMdagMPV (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...

MdagMMultiSystemSolverAccumulateArray< LF > *	mInvMdagMPVAcc (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::DiffFermAct5D< T, P, Q >
virtual	~DiffFermAct5D ()
	Virtual destructor to help with cleanup;. More...

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

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

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

SystemSolverArray< LatticeFermion > *	qpropT (Handle< FermState< LatticeFermion, 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...

	EvenOddPrecOvExtFermActArray ()
	Default constructor. More...

void	operator= (const EvenOddPrecOvExtFermActArray &a)
	Hide =. More...

Private Member Functions
int	getN5FromRatPolyDeg (const int &RatPolyDeg) const
	Part of initializer. More...

void	init (int &Npoles, Real &coeffP, multi1d< Real > &resP, multi1d< Real > &rootQ) const
	Get the rational approximation coefficients. More...

Private Attributes
Handle< CreateFermState< T, P, Q > >	cfs

Handle< AbsOvExtTuningStrategy >	theTuningStrategy

EvenOddPrecOvExtFermActArrayParams	param

Detailed Description

EvenOddPreconditioned Extended-Overlap (N&N) linear operator.

This operator applies the extended version of the hermitian overlap operator Chi = ((1+Mass)/(1-Mass)*gamma_5 + B) . Psi where B is the continued fraction of the pole approx. to eps(H(m))

Definition at line 57 of file eoprec_ovext_fermact_array_w.h.

Member Typedef Documentation

◆ P

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

Definition at line 63 of file eoprec_ovext_fermact_array_w.h.

◆ Q

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

Definition at line 64 of file eoprec_ovext_fermact_array_w.h.

◆ T

typedef LatticeFermion Chroma::EvenOddPrecOvExtFermActArray::T

Definition at line 62 of file eoprec_ovext_fermact_array_w.h.

Constructor & Destructor Documentation

◆ EvenOddPrecOvExtFermActArray() [1/3]

Chroma::EvenOddPrecOvExtFermActArray::EvenOddPrecOvExtFermActArray	(	Handle< CreateFermState< T, P, Q > >	cfs_,
		const EvenOddPrecOvExtFermActArrayParams &	param_
	)

General FermBC.

Definition at line 132 of file eoprec_ovext_fermact_array_w.cc.

References Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), param, Chroma::read(), theTuningStrategy, and Chroma::EvenOddPrecOvExtFermActArrayParams::tuning_strategy_xml.

◆ EvenOddPrecOvExtFermActArray() [2/3]

Chroma::EvenOddPrecOvExtFermActArray::EvenOddPrecOvExtFermActArray ( const EvenOddPrecOvExtFermActArray & a )

inline

Copy constructor.

Definition at line 71 of file eoprec_ovext_fermact_array_w.h.

◆ ~EvenOddPrecOvExtFermActArray()

Chroma::EvenOddPrecOvExtFermActArray::~EvenOddPrecOvExtFermActArray ( )

inline

Destructor is automatic.

Definition at line 126 of file eoprec_ovext_fermact_array_w.h.

◆ EvenOddPrecOvExtFermActArray() [3/3]

Chroma::EvenOddPrecOvExtFermActArray::EvenOddPrecOvExtFermActArray ( )

inlineprotected

Default constructor.

Definition at line 133 of file eoprec_ovext_fermact_array_w.h.

Member Function Documentation

◆ DeltaLs()

LinearOperator<T>* Chroma::EvenOddPrecOvExtFermActArray::DeltaLs	(	Handle< FermState< T, P, Q > >	state,
		const GroupXML_t &	invParam
	)		const

inlinevirtual

Produce a DeltaLs = 1-epsilon^2(H) operator.

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

Definition at line 111 of file eoprec_ovext_fermact_array_w.h.

References linOp4D(), and Chroma::state.

◆ getCreateState()

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

inlineprotectedvirtual

Return the fermion BC object for this action.

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

Definition at line 130 of file eoprec_ovext_fermact_array_w.h.

References cfs.

◆ getN5FromRatPolyDeg()

int Chroma::EvenOddPrecOvExtFermActArray::getN5FromRatPolyDeg ( const int & RatPolyDeg ) const

private

Part of initializer.

Definition at line 153 of file eoprec_ovext_fermact_array_w.cc.

References RatPolyDeg.

Referenced by init(), and size().

◆ getQuarkMass()

Real Chroma::EvenOddPrecOvExtFermActArray::getQuarkMass ( ) const

inlinevirtual

Return the quark mass.

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

Definition at line 78 of file eoprec_ovext_fermact_array_w.h.

References Chroma::EvenOddPrecOvExtFermActArrayParams::Mass, and param.

◆ hermitianLinOp()

LinearOperatorArray<T>* Chroma::EvenOddPrecOvExtFermActArray::hermitianLinOp ( Handle< FermState< T, P, Q > > state ) const

inlinevirtual

Produce a hermitian version of the linear operator.

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

Definition at line 92 of file eoprec_ovext_fermact_array_w.h.

◆ init()

void Chroma::EvenOddPrecOvExtFermActArray::init	(	int &	Npoles,
		Real &	coeffP,
		multi1d< Real > &	resP,
		multi1d< Real > &	rootQ
	)		const

private

Get the rational approximation coefficients.

Definition at line 169 of file eoprec_ovext_fermact_array_w.cc.

References Chroma::StagPhases::alpha(), Chroma::EvenOddPrecOvExtFermActArrayParams::approximation_type, Chroma::EvenOddPrecOvExtFermActArrayParams::ApproxMax, Chroma::EvenOddPrecOvExtFermActArrayParams::ApproxMin, Chroma::COEFF_TYPE_TANH_UNSCALED, Chroma::COEFF_TYPE_ZOLOTAREV, Chroma::StaggeredFlavorOperators::AntiSymmetricTensor4D::eps, getN5FromRatPolyDeg(), higham(), Chroma::EvenOddPrecOvExtFermActArrayParams::Mass, n, param, Chroma::EvenOddPrecOvExtFermActArrayParams::RatPolyDeg, t, zolotarev(), and zolotarev_free().

Referenced by linOp().

◆ linOp()

EvenOddPrecConstDetLinearOperatorArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > * Chroma::EvenOddPrecOvExtFermActArray::linOp ( Handle< FermState< T, P, Q > > state ) const

virtual

Produce a linear operator for this action.

The operator acts on the entire lattice

Parameters

state gauge field (Read)

Implements Chroma::EvenOddPrecConstDetWilsonTypeFermAct5D< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 362 of file eoprec_ovext_fermact_array_w.cc.

References Chroma::EvenOddPrecOvExtFermActArrayParams::b5, Chroma::StagPhases::beta(), Chroma::EvenOddPrecOvExtFermActArrayParams::c5, init(), Chroma::EvenOddPrecOvExtFermActArrayParams::Mass, Chroma::EvenOddPrecOvExtFermActArrayParams::OverMass, param, and Chroma::state.

Referenced by qprop().

◆ linOp4D()

LinearOperator<T>* Chroma::EvenOddPrecOvExtFermActArray::linOp4D	(	Handle< FermState< T, P, Q > >	state,
		const Real &	m_q,
		const GroupXML_t &	invParam
	)		const