lwldslash_base_array_w.h

Go to the documentation of this file.

// -*- C++ -*-
/*! \file
 *  \brief Wilson Dslash linear operator over arrays
 */
 
#ifndef __lwldslash_base_array_h__
#define __lwldslash_base_array_h__
 
#include "linearop.h"
#include "io/aniso_io.h"
 
 
namespace Chroma 
{ 
  //! General Wilson-Dirac dslash over arrays
  /*!
   * \ingroup linop
   *
   * DSLASH
   *
   * This routine is specific to Wilson fermions!
   *
   * Description:
   *
   * This routine applies the operator D' to Psi, putting the result in Chi.
   *
   *           Nd-1
   *           ---
   *           \
   *   chi(x)  :=  >  U  (x) (1 - isign gamma  ) psi(x+mu)
   *           /    mu                    mu
   *           ---
   *           mu=0
   *
   *                 Nd-1
   *                 ---
   *                 \    +
   *                +    >  U  (x-mu) (1 + isign gamma  ) psi(x-mu)
   *                 /    mu                       mu
   *                 ---
   *                 mu=0
   *
   */
 
  class WilsonDslashBaseArray : public DslashLinearOperatorArray<LatticeFermion, 
            multi1d<LatticeColorMatrix>, multi1d<LatticeColorMatrix> >
  {
  public:
    // Typedefs to save typing
    typedef LatticeFermion               T;
    typedef multi1d<LatticeColorMatrix>  P;
    typedef multi1d<LatticeColorMatrix>  Q;
 
    //! No real need for cleanup here
    virtual ~WilsonDslashBaseArray() {}
 
    //! Subset is all here
    const Subset& subset() const {return all;}
 
    /**
     * Apply a std::vector dslash
     *
     * \param chi     result                                      (Write)
     * \param psi     source                                      (Read)
     * \param isign   D'^dag or D'  ( MINUS | PLUS ) resp.        (Read)
     * \param cb      Checkerboard of OUTPUT std::vector               (Read) 
     *
     * \return The output of applying dslash on psi
     */
    virtual void apply (multi1d<LatticeFermion>& chi, 
                        const multi1d<LatticeFermion>& psi, 
                        enum PlusMinus isign, int cb) const = 0;
 
    /**
     * Apply a dslash
     *
     * \param chi     result                                      (Write)
     * \param psi     source                                      (Read)
     * \param isign   D'^dag or D'  ( MINUS | PLUS ) resp.        (Read)
     * \param cb      Checkerboard of OUTPUT std::vector               (Read) 
     *
     * \return The output of applying dslash on psi
     */
    virtual void apply (LatticeFermion& chi, 
                        const LatticeFermion& psi, 
                        enum PlusMinus isign, int cb) const = 0;
 
    //! Take deriv of D
    /*!
     * \param chi     left std::vector                                 (Read)
     * \param psi     right std::vector                                (Read)
     * \param isign   D'^dag or D'  ( MINUS | PLUS ) resp.        (Read)
     *
     * \return Computes   \f$\chi^\dag * \dot(D} * \psi\f$
     */
    virtual void deriv(multi1d<LatticeColorMatrix>& ds_u, 
                       const multi1d<LatticeFermion>& chi, 
                       const multi1d<LatticeFermion>& psi, 
                       enum PlusMinus isign) const;
 
 
    //! Take deriv of D
    /*!
     * \param chi     left std::vector on cb                           (Read)
     * \param psi     right std::vector on 1-cb                        (Read)
     * \param isign   D'^dag or D'  ( MINUS | PLUS ) resp.        (Read)
     * \param cb      Checkerboard of chi std::vector                  (Read)
     *
     * \return Computes   \f$\chi^\dag * \dot(D} * \psi\f$
     */
    virtual void deriv(multi1d<LatticeColorMatrix>& ds_u, 
                       const multi1d<LatticeFermion>& chi, 
                       const multi1d<LatticeFermion>& psi, 
                       enum PlusMinus isign, int cb) const;
 
    //! Take deriv of D
    /*!
     * \param chi     left std::vector                                 (Read)
     * \param psi     right std::vector                                (Read)
     * \param isign   D'^dag or D'  ( MINUS | PLUS ) resp.        (Read)
     * \param cb      Checkerboard of chi std::vector                  (Read)
     *
     * \return Computes   \f$\chi^\dag * \dot(D} * \psi\f$
     */
    virtual void deriv(multi1d<LatticeColorMatrix>& ds_u, 
                       const LatticeFermion& chi, 
                       const LatticeFermion& psi, 
                       enum PlusMinus isign, int cb) const;
 
    //! Return flops performed by the operator()
    unsigned long nFlops() const;
 
    //! Return the fermion BC object for this linear operator
    virtual const FermBC<T,P,Q>& getFermBC() const = 0;
 
  protected:
    //! Get the anisotropy parameters
    virtual const multi1d<Real>& getCoeffs() const = 0;
 
  };
 
 
} // End Namespace Chroma
 
 
#endif