curcor3_w.h

Go to the documentation of this file.

// -*- C++ -*-
 
#ifndef __curcor3_h__
#define __curcor3_h__
 
#include "chromabase.h"
#include "util/ft/sftmom.h"
 
namespace Chroma {
 
//! Construct current correlators 
/*!
 * \ingroup hadron
 *
 * This routine is specific to Wilson fermions!
 *
 *  The two propagators can be identical or different.
 
 * This includes the "rho_1--rho_2" correlators used for O(a) improvement
 
 * For use with "rotated" propagators we added the possibility of also
 * computing the local std::vector current, when no_vec_cur = 4. In this
 * case the 3 local currents come last.
 
 * \param u               gauge field ( Read )
 * \param quark_prop_1    first quark propagator ( Read )
 * \param quark_prop_2    second (anti-) quark propagator ( Read )
 * \param phases          fourier transform phase factors ( Read )
 * \param t0              timeslice coordinate of the source ( Read )
 * \param no_vec_cur      number of std::vector current types, 3 or 4 ( Read )
 * \param xml             namelist file object ( Read )
 * \param xml_group       std::string used for writing xml data ( Read )
 *
 *         ____
 *         \
 * cc(t) =  >  < m(t_source, 0) c(t + t_source, x) >
 *         /                    
 *         ----
 *           x
 */
 
void curcor3(const multi1d<LatticeColorMatrix>& u, 
             const LatticePropagator& quark_prop_1, 
             const LatticePropagator& quark_prop_2, 
             const SftMom& phases,
             int t0,
             int no_vec_cur,
             XMLWriter& xml,
             const std::string& xml_group);
 
}  // end namespace Chroma
 
#endif