lovddag_w.h

Go to the documentation of this file.

// -*- C++ -*-
/*! \file
 *  \brief Internal Overlap-pole operator
 */
 
#ifndef __lovddag_w_h__
#define __lovddag_w_h__
 
#include "linearop.h"
#include "unprec_wilstype_fermact_w.h" 
#include "meas/eig/eig_w.h"
 
 
namespace Chroma 
{ 
  //! Internal Overlap-pole operator
  /*!
   * \ingroup linop
   *
   * This routine is specific to Wilson fermions!
   *
   *   Chi  =   (1/2)*((1+m_q) + (1-m_q) * gamma_5 * B) . Psi 
   *  where  B  is the pole approx. to eps(H(m)) 
   *
   * Internally, it computes
   *   Chi  =   ((1+m_q)/(1-m_q) + gamma_5 * B) . Psi 
   * and then rescales at the end to the correct normalization
   *
   *  NOTE: B is hermitian, so       
   *     (1 + gamma_5 * B)^dag = (1 + B * gamma_5) 
   *                           = gamma_5 * (1 + gamma_5 * B) * gamma_5 
   */
 
  class lovddag : public DiffLinearOperator<LatticeFermion, 
            multi1d<LatticeColorMatrix>, multi1d<LatticeColorMatrix> >
  {
  public:
    // Typedefs to save typing
    typedef LatticeFermion               T;
    typedef multi1d<LatticeColorMatrix>  P;
    typedef multi1d<LatticeColorMatrix>  Q;
 
    //! Creation routine
    /*!
     * \ingroup linop
     *
     * \param _MdagM          M^dag.M of underlying linop M      (Read)
     * \param _M              Underlying linop M                       (Read)
     * \param _m_q            quark mass                         (Read)
     * \param _numroot      number of poles in expansion       (Read)
     * \param _constP         constant coeff                     (Read)
     * \param _resP           numerator                          (Read)
     * \param _rootQ          denom                              (Read)
     * \param _OperEigVec     eigenvectors                             (Read)
     * \param _EigValFunc     eigenvalues                      (Read)
     * \param _NEig           number of eigenvalues              (Read)
     * \param _MaxCG          MaxCG inner CG                     (Read)
     * \param _RsdCG          default residual for inner CG      (Read)
     */
    lovddag(const UnprecWilsonTypeFermAct<T,P,Q>& S_aux,
            Handle< FermState<T,P,Q> > state,
            const Real& _m_q, int _numroot, 
            const Real& _constP, 
            const multi1d<Real>& _resP,
            const multi1d<Real>& _rootQ, 
            int _NEig,
            const multi1d<Real>& _EigValFunc,
            const multi1d<LatticeFermion>& _EigVec,
            int _MaxCG,
            const Real& _RsdCG,
            const int _ReorthFreq,
            const Chirality _ichiral) :
      M(S_aux.linOp(state)), MdagM(S_aux.lMdagM(state)), fbc(state->getFermBC()),
      m_q(_m_q), numroot(_numroot), constP(_constP),
      rootQ(_rootQ), resP(_resP), EigVec(_EigVec), EigValFunc(_EigValFunc),
      NEig(_NEig), MaxCG(_MaxCG), RsdCG(_RsdCG), ReorthFreq(_ReorthFreq), ichiral(_ichiral) {};
 
    //! Destructor is automatic
    ~lovddag() {}
 
    //! Only defined on the entire lattice
    const Subset& subset() const {return all;}
 
    //! Apply the operator onto a source std::vector
    void operator() (LatticeFermion& chi, const LatticeFermion& psi, enum PlusMinus isign) const;
 
    //! Apply the operator onto a source std::vector, with user supplied epsilon
    //  for RsdCG
    void operator() (LatticeFermion& chi, const LatticeFermion& psi, enum PlusMinus isign, Real epsilon) const;
 
    //! Return the fermion BC object for this linear operator
    const FermBC<T,P,Q>& getFermBC() const {return *fbc;}
 
  private:
    Handle< DiffLinearOperator<T,P,Q> > M;
    Handle< DiffLinearOperator<T,P,Q> > MdagM;
    Handle< FermBC<T,P,Q> >             fbc;
 
    // Copy all of these rather than reference them.
    const Real m_q;
    int numroot;
    const Real constP;
    const multi1d<Real> rootQ;
    const multi1d<Real> resP;
    const multi1d<LatticeFermion> EigVec;
    const multi1d<Real> EigValFunc;
    int NEig;
    int MaxCG;
    const Real RsdCG;
    const int  ReorthFreq;
    Chirality ichiral;
  };
 
 
} // End Namespace Chroma
 
 
#endif