CHROMA
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members

4D style even-odd preconditioned domain-wall fermion action More...

#include <eoprec_nef_fermact_array_w.h>

Inheritance diagram for Chroma::EvenOddPrecNEFFermActArray:
Chroma::EvenOddPrecDWFermActBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddPrecConstDetWilsonTypeFermAct5D< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddPrecWilsonTypeFermAct5D< T, P, Q > Chroma::EvenOddPrecWilsonTypeFermAct5D< T, P, Q > Chroma::WilsonTypeFermAct5D< T, P, Q > Chroma::WilsonTypeFermAct5D< T, P, Q > Chroma::WilsonTypeFermAct5D< T, P, Q > Chroma::WilsonTypeFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q > Chroma::DiffFermAct5D< T, P, Q >

Public Types

typedef LatticeFermion T
 
typedef multi1d< LatticeColorMatrix > P
 
typedef multi1d< LatticeColorMatrix > Q
 

Public Member Functions

 EvenOddPrecNEFFermActArray (Handle< CreateFermState< T, P, Q > > cfs_, const EvenOddPrecNEFFermActArrayParams &p)
 General constructor. More...
 
 EvenOddPrecNEFFermActArray (const EvenOddPrecNEFFermActArray &a)
 Copy constructor. More...
 
int size () const
 Length of DW flavor index/space. More...
 
Real getQuarkMass () const
 Return the quark mass. More...
 
UnprecDWLikeLinOpBaseArray< T, P, Q > * unprecLinOp (Handle< FermState< T, P, Q > > state, const Real &m_q) const
 Produce an unpreconditioned linear operator for this action with arbitrary quark mass. More...
 
EvenOddPrecDWLikeLinOpBaseArray< T, P, Q > * precLinOp (Handle< FermState< T, P, Q > > state, const Real &m_q) const
 Produce an even-odd preconditioned linear operator for this action with arbitrary quark mass. More...
 
 ~EvenOddPrecNEFFermActArray ()
 Destructor is automatic. More...
 
void quarkProp (LatticePropagator &q_sol, XMLWriter &xml_out, const LatticePropagator &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...
 
- Public Member Functions inherited from Chroma::EvenOddPrecDWFermActBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >
virtual EvenOddPrecDWLikeLinOpBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > * linOp (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state) const
 Override to produce a DWF-link even-odd prec. linear operator for this action. More...
 
virtual EvenOddPrecDWLikeLinOpBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > * linOpPV (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state) const
 Override to produce a DWF-link even-odd prec. Pauli-Villars linear operator for this action. More...
 
virtual LinearOperatorArray< LatticeFermion > * hermitianLinOp (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state) const
 Produce a hermitian version of the linear operator. More...
 
virtual LinearOperator< LatticeFermion > * linOp4D (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > 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...
 
virtual LinearOperator< LatticeFermion > * DeltaLs (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const
 Produce a DeltaLs = 1-epsilon^2(H) operator. More...
 
SystemSolver< LatticeFermion > * qprop (Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, const GroupXML_t &invParam) const
 Define quark propagator routine for 4D fermions. More...
 
SystemSolver< LF > * qprop (Handle< FermState< LF, LCM, LCM > > state, const GroupXML_t &invParam) const
 
void Dminus (LatticeFermion &chi, const LatticeFermion &psi, Handle< FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > > state, enum PlusMinus isign, int s5) const
 Apply the Dminus operator on a fermion. 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^dag*PV*psi=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^dag*PV+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^dag*PV*psi=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^dag*PV+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^dag*PV*psi=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...
 
 EvenOddPrecNEFFermActArray ()
 Partial constructor. More...
 
void operator= (const EvenOddPrecNEFFermActArray &a)
 Hide =. More...
 

Private Attributes

Handle< CreateFermState< T, P, Q > > cfs
 
EvenOddPrecNEFFermActArrayParams params
 

Detailed Description

4D style even-odd preconditioned domain-wall fermion action

4D style even-odd preconditioned domain-wall fermion action. Follows notes of Orginos (10/2003)

Hopefully, the conventions used here are specified in Phys.Rev.D63:094505,2001 (hep-lat/0005002).

Definition at line 50 of file eoprec_nef_fermact_array_w.h.

Member Typedef Documentation

◆ P

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

Definition at line 56 of file eoprec_nef_fermact_array_w.h.

◆ Q

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

Definition at line 57 of file eoprec_nef_fermact_array_w.h.

◆ T

typedef LatticeFermion Chroma::EvenOddPrecNEFFermActArray::T

Definition at line 55 of file eoprec_nef_fermact_array_w.h.

Constructor & Destructor Documentation

◆ EvenOddPrecNEFFermActArray() [1/3]

Chroma::EvenOddPrecNEFFermActArray::EvenOddPrecNEFFermActArray ( Handle< CreateFermState< T, P, Q > >  cfs_,
const EvenOddPrecNEFFermActArrayParams p 
)
inline

◆ EvenOddPrecNEFFermActArray() [2/3]

Chroma::EvenOddPrecNEFFermActArray::EvenOddPrecNEFFermActArray ( const EvenOddPrecNEFFermActArray a)
inline

Copy constructor.

Definition at line 73 of file eoprec_nef_fermact_array_w.h.

◆ ~EvenOddPrecNEFFermActArray()

Chroma::EvenOddPrecNEFFermActArray::~EvenOddPrecNEFFermActArray ( )
inline

Destructor is automatic.

Definition at line 91 of file eoprec_nef_fermact_array_w.h.

◆ EvenOddPrecNEFFermActArray() [3/3]

Chroma::EvenOddPrecNEFFermActArray::EvenOddPrecNEFFermActArray ( )
inlineprotected

Partial constructor.

Definition at line 122 of file eoprec_nef_fermact_array_w.h.

Member Function Documentation

◆ getCreateState()

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

Return the fermion BC object for this action.

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

Definition at line 119 of file eoprec_nef_fermact_array_w.h.

References cfs.

◆ getQuarkMass()

Real Chroma::EvenOddPrecNEFFermActArray::getQuarkMass ( ) const
inlinevirtual

◆ operator=()

void Chroma::EvenOddPrecNEFFermActArray::operator= ( const EvenOddPrecNEFFermActArray a)
inlineprotected

Hide =.

Definition at line 124 of file eoprec_nef_fermact_array_w.h.

◆ precLinOp()

EvenOddPrecDWLikeLinOpBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > * Chroma::EvenOddPrecNEFFermActArray::precLinOp ( Handle< FermState< T, P, Q > >  state,
const Real &  m_q 
) const
virtual

◆ quarkProp()

void Chroma::EvenOddPrecNEFFermActArray::quarkProp ( LatticePropagator &  q_sol,
XMLWriter &  xml_out,
const LatticePropagator &  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.

This routine is actually generic to Domain Wall fermions (Array) fermions

Parameters
q_solquark propagator ( Write )
q_srcsource ( Read )
xml_outdiagnostic output ( Modify )
stategauge connection state ( Read )
t_srctime slice of source ( Read )
j_decaydirection of decay ( Read )
invParaminverter parameters ( Read )
obsvPcompute currents and residual mass ( Read )
ncg_hadnumber of CG iterations ( Write )

Definition at line 116 of file eoprec_nef_fermact_array_w.cc.

References j_decay, Chroma::nef_quarkProp4(), Chroma::EvenOddPrecDWFermActBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >::qprop(), Chroma::QUARK_SPIN_TYPE_FULL, Chroma::quarkProp4(), and Chroma::state.

◆ size()

int Chroma::EvenOddPrecNEFFermActArray::size ( void  ) const
inlinevirtual

Length of DW flavor index/space.

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

Definition at line 77 of file eoprec_nef_fermact_array_w.h.

References Chroma::EvenOddPrecNEFFermActArrayParams::N5, and params.

Referenced by main().

◆ unprecLinOp()

UnprecDWLikeLinOpBaseArray< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > * Chroma::EvenOddPrecNEFFermActArray::unprecLinOp ( Handle< FermState< T, P, Q > >  state,
const Real &  m_q 
) const
virtual

Member Data Documentation

◆ cfs

Handle< CreateFermState<T,P,Q> > Chroma::EvenOddPrecNEFFermActArray::cfs
private

Definition at line 127 of file eoprec_nef_fermact_array_w.h.

Referenced by getCreateState().

◆ params

EvenOddPrecNEFFermActArrayParams Chroma::EvenOddPrecNEFFermActArray::params
private

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