CHROMA
Public Member Functions | List of all members
Chroma::DiffFermAct4D< T, P, Q > Class Template Referenceabstract

Base class for quadratic matter actions (e.g., fermions) More...

#include <fermact.h>

Inheritance diagram for Chroma::DiffFermAct4D< T, P, Q >:
Chroma::FermAct4D< T, P, Q > Chroma::FermAct4D< T, P, Q > Chroma::FermionAction< T, P, Q > Chroma::FermionAction< T, P, Q > Chroma::FermionAction< T, P, Q > Chroma::FermionAction< T, P, Q > Chroma::StaggeredTypeFermAct< T, P, Q > Chroma::StaggeredTypeFermAct< T, P, Q > Chroma::WilsonTypeFermAct< T, P, Q > Chroma::WilsonTypeFermAct< T, P, Q > Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddStaggeredTypeFermAct< T, P, Q > Chroma::EvenOddStaggeredTypeFermAct< T, P, Q > Chroma::UnprecStaggeredTypeFermAct< T, P, Q > Chroma::UnprecStaggeredTypeFermAct< T, P, Q > Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecStaggeredTypeFermAct< LatticeStaggeredFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddStaggeredTypeFermAct< T, P, Q > Chroma::EvenOddStaggeredTypeFermAct< T, P, Q > Chroma::UnprecStaggeredTypeFermAct< T, P, Q > Chroma::UnprecStaggeredTypeFermAct< T, P, Q > Chroma::PolyWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::PolyWilsonTypeFermAct< T, P, Q > Chroma::SymEvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::UnprecWilsonTypeFermAct< T, P, Q > Chroma::UnprecWilsonTypeFermAct< T, P, Q > Chroma::PolyWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > > Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::PolyWilsonTypeFermAct< T, P, Q > Chroma::SymEvenOddPrecWilsonTypeFermAct< T, P, Q > Chroma::UnprecWilsonTypeFermAct< T, P, Q > Chroma::UnprecWilsonTypeFermAct< T, P, Q >

Public Member Functions

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 LinOpSystemSolver< T > * invLinOp (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const =0
 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 =0
 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 =0
 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 =0
 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 =0
 Return a multi-shift accumulate solver. 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 LinOpSystemSolver< T > * invLinOp (Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam) const =0
 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 =0
 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 =0
 Return a multi-shift linear operator solver for this action to solve (MdagM+shift)*psi=chi. 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, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, int &ncg_had) const =0
 Given a complete propagator as a source, this does all the inversions needed. 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, Handle< FermState< T, P, Q > > state, const GroupXML_t &invParam, QuarkSpinType quarkSpinType, int &ncg_had) const =0
 Given a complete propagator as a source, this does all the inversions needed. 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::DiffFermAct4D< T, P, Q >

Base class for quadratic matter actions (e.g., fermions)

Supports creation and application for quadratic actions with derivatives This is basically a foundry class with additional operations.

Definition at line 223 of file fermact.h.

Constructor & Destructor Documentation

◆ ~DiffFermAct4D() [1/2]

template<typename T , typename P , typename Q >
virtual Chroma::DiffFermAct4D< T, P, Q >::~DiffFermAct4D ( )
inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 227 of file fermact.h.

◆ ~DiffFermAct4D() [2/2]

template<typename T , typename P , typename Q >
virtual Chroma::DiffFermAct4D< T, P, Q >::~DiffFermAct4D ( )
inlinevirtual

Virtual destructor to help with cleanup;.

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

Member Function Documentation

◆ linOp() [1/2]

template<typename T , typename P , typename Q >
virtual DiffLinearOperator<T,Q,P>* Chroma::DiffFermAct4D< T, P, Q >::linOp ( Handle< FermState< T, P, Q > >  state) const
pure virtual

Produce a linear operator for this action.

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

Implemented in Chroma::UnprecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddStaggeredTypeFermAct< T, P, Q >, Chroma::UnprecStaggeredTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddStaggeredTypeFermAct< T, P, Q >, Chroma::UnprecStaggeredTypeFermAct< T, P, Q >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::UnprecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::UnprecWilsonFermAct, Chroma::UnprecW12FermAct, Chroma::UnprecParWilsonFermAct, Chroma::UnprecHamberWuFermAct, Chroma::UnprecGrapheneFermAct, Chroma::UnprecDWFTransfFermAct, Chroma::UnprecCloverFermAct, Chroma::SymEvenOddPrecCloverFermAct, Chroma::PolyChebFermAct, Chroma::OverlapFermActBase, Chroma::EvenOddPrecWilsonFermAct, Chroma::EvenOddPrecWilsonCoarseFineFermAct, Chroma::EvenOddPrecSLRCFermAct, Chroma::EvenOddPrecSLICFermAct, Chroma::EvenOddPrecParWilsonFermAct, Chroma::EvenOddPrecCloverOrbifoldFermAct, Chroma::EvenOddPrecCloverFermAct, Chroma::EvenOddPrecCloverExtFieldFermAct, Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::SymEvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, and Chroma::EvenOddPrecConstDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Referenced by Chroma::OneFlavorRatExactWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::OneFlavorRatioRatConvExactWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::OneFlavorRatioRatRatExactWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::TwoFlavorExactWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::TwoFlavorExactRatioConvConvWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::TwoFlavorExactRatioConvRatWilsonTypeFermMonomial< P, Q, Phi >::dsdq(), Chroma::TwoFlavorExactRatioConvRatWilsonTypeFermMonomial< P, Q, Phi >::getX(), Chroma::WilsonTypeFermAct< T, P, Q >::lMdagM(), Chroma::TwoFlavorExactRatioConvConvWilsonTypeFermMonomial< P, Q, Phi >::refreshInternalFields(), Chroma::TwoFlavorExactRatioConvRatWilsonTypeFermMonomial< P, Q, Phi >::refreshInternalFields(), Chroma::OneFlavorRatExactWilsonTypeFermMonomial< P, Q, Phi >::refreshInternalFields(), Chroma::OneFlavorRatioRatConvExactWilsonTypeFermMonomial< P, Q, Phi >::refreshInternalFields(), Chroma::OneFlavorRatioRatRatExactWilsonTypeFermMonomial< P, Q, Phi >::refreshInternalFields(), Chroma::TwoFlavorExactUnprecRatioConvConvWilsonTypeFermMonomial< P, Q, Phi >::S(), Chroma::TwoFlavorExactUnprecRatioConvRatWilsonTypeFermMonomial< P, Q, Phi >::S(), Chroma::TwoFlavorExactEvenOddPrecPolyPrecWilsonTypeFermMonomial< P, Q, Phi >::S_odd_odd(), Chroma::TwoFlavorExactEOPrecRatioConvConvWilsonTypeFermMonomialT< P, Q, Phi, EOFermActT, EOLinOpT >::S_odd_odd(), Chroma::TwoFlavorExactEvenOddPrecRatioConvRatWilsonTypeFermMonomial< P, Q, Phi >::S_odd_odd(), Chroma::OneFlavorRatExactWilsonTypeFermMonomial< P, Q, Phi >::S_subset(), Chroma::OneFlavorRatioRatConvExactWilsonTypeFermMonomial< P, Q, Phi >::S_subset(), and Chroma::OneFlavorRatioRatRatExactWilsonTypeFermMonomial< P, Q, Phi >::S_subset().

◆ linOp() [2/2]

template<typename T , typename P , typename Q >
virtual DiffLinearOperator<T,Q,P>* Chroma::DiffFermAct4D< T, P, Q >::linOp ( Handle< FermState< T, P, Q > >  state) const
pure virtual

Produce a linear operator for this action.

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

Implemented in Chroma::UnprecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddStaggeredTypeFermAct< T, P, Q >, Chroma::UnprecStaggeredTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::SymEvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddStaggeredTypeFermAct< T, P, Q >, Chroma::UnprecStaggeredTypeFermAct< T, P, Q >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::UnprecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< T, P, Q >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< T, P, Q >, Chroma::UnprecWilsonFermAct, Chroma::UnprecW12FermAct, Chroma::UnprecParWilsonFermAct, Chroma::UnprecHamberWuFermAct, Chroma::UnprecGrapheneFermAct, Chroma::UnprecDWFTransfFermAct, Chroma::UnprecCloverFermAct, Chroma::SymEvenOddPrecCloverFermAct, Chroma::PolyChebFermAct, Chroma::OverlapFermActBase, Chroma::EvenOddPrecWilsonFermAct, Chroma::EvenOddPrecWilsonCoarseFineFermAct, Chroma::EvenOddPrecSLRCFermAct, Chroma::EvenOddPrecSLICFermAct, Chroma::EvenOddPrecParWilsonFermAct, Chroma::EvenOddPrecCloverOrbifoldFermAct, Chroma::EvenOddPrecCloverFermAct, Chroma::EvenOddPrecCloverExtFieldFermAct, Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::SymEvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecConstDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::UnprecWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, Chroma::EvenOddPrecLogDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >, and Chroma::EvenOddPrecConstDetWilsonTypeFermAct< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

◆ lMdagM() [1/2]

template<typename T , typename P , typename Q >
virtual DiffLinearOperator<T,Q,P>* Chroma::DiffFermAct4D< T, P, Q >::lMdagM ( Handle< FermState< T, P, Q > >  state) const
pure virtual

◆ lMdagM() [2/2]

template<typename T , typename P , typename Q >
virtual DiffLinearOperator<T,Q,P>* Chroma::DiffFermAct4D< T, P, Q >::lMdagM ( Handle< FermState< T, P, Q > >  state) const
pure virtual

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