inline_meson_matelem_colorvec_w.cc

Go to the documentation of this file.

/*! \file
 * \brief Inline measurement of meson operators via colorstd::vector matrix elements
 */
 
 
 
#include "handle.h"
#include "meas/inline/hadron/inline_meson_matelem_colorvec_w.h"
#include "meas/inline/abs_inline_measurement_factory.h"
#include "meas/smear/link_smearing_aggregate.h"
#include "meas/smear/link_smearing_factory.h"
#include "meas/smear/displace.h"
#include "meas/glue/mesplq.h"
#include "util/ferm/subset_vectors.h"
#include "util/ferm/key_val_db.h"
#include "util/ft/sftmom.h"
#include "util/info/proginfo.h"
#include "meas/inline/make_xml_file.h"
 
#include "meas/inline/io/named_objmap.h"
 
#define COLORVEC_MATELEM_TYPE_ZERO       0
#define COLORVEC_MATELEM_TYPE_ONE        1
#define COLORVEC_MATELEM_TYPE_MONE       -1
#define COLORVEC_MATELEM_TYPE_GENERIC    10
 
namespace Chroma 
{ 
  /*!
   * \ingroup hadron
   *
   * @{
   */
  namespace InlineMesonMatElemColorVecEnv 
  { 
    // Reader for input parameters
    void read(XMLReader& xml, const std::string& path, InlineMesonMatElemColorVecEnv::Params::Param_t& param)
    {
      XMLReader paramtop(xml, path);
    
      int version;
      read(paramtop, "version", version);
 
      switch (version) 
      {
      case 1:
        /**************************************************************************/
        param.mom2_min = 0;
        param.mom_list.resize(0);
        break;
 
      case 2:
        /**************************************************************************/
        read(paramtop, "mom2_min", param.mom2_min);
        param.mom_list.resize(0);
        break;
 
      case 3:
        /**************************************************************************/
        read(paramtop, "mom2_min", param.mom2_min);
        read(paramtop, "mom_list", param.mom_list);
        break;
 
      default :
        /**************************************************************************/
 
        QDPIO::cerr << "Input parameter version " << version << " unsupported." << std::endl;
        QDP_abort(1);
      }
 
      read(paramtop, "mom2_max", param.mom2_max);
      read(paramtop, "displacement_length", param.displacement_length);
      read(paramtop, "displacement_list", param.displacement_list);
      read(paramtop, "num_vecs", param.num_vecs);
      read(paramtop, "decay_dir", param.decay_dir);
      read(paramtop, "orthog_basis", param.orthog_basis);
 
      param.link_smearing  = readXMLGroup(paramtop, "LinkSmearing", "LinkSmearingType");
    }
 
 
    // Writer for input parameters
    void write(XMLWriter& xml, const std::string& path, const InlineMesonMatElemColorVecEnv::Params::Param_t& param)
    {
      push(xml, path);
 
      int version = 3;
 
      write(xml, "version", version);
      write(xml, "mom2_min", param.mom2_min);
      write(xml, "mom2_max", param.mom2_max);
      write(xml, "mom_list", param.mom_list);
      write(xml, "displacement_length", param.displacement_length);
      write(xml, "displacement_list", param.displacement_list);
      write(xml, "num_vecs", param.num_vecs);
      write(xml, "decay_dir", param.decay_dir);
      write(xml, "orthog_basis", param.orthog_basis);
     xml << param.link_smearing.xml;
 
      pop(xml);
    }
 
    //! Read named objects 
    void read(XMLReader& xml, const std::string& path, InlineMesonMatElemColorVecEnv::Params::NamedObject_t& input)
    {
      XMLReader inputtop(xml, path);
 
      read(inputtop, "gauge_id", input.gauge_id);
      read(inputtop, "colorvec_id", input.colorvec_id);
      read(inputtop, "meson_op_file", input.meson_op_file);
    }
 
    //! Write named objects
    void write(XMLWriter& xml, const std::string& path, const InlineMesonMatElemColorVecEnv::Params::NamedObject_t& input)
    {
      push(xml, path);
 
      write(xml, "gauge_id", input.gauge_id);
      write(xml, "colorvec_id", input.colorvec_id);
      write(xml, "meson_op_file", input.meson_op_file);
 
      pop(xml);
    }
 
    // Writer for input parameters
    void write(XMLWriter& xml, const std::string& path, const InlineMesonMatElemColorVecEnv::Params& param)
    {
      param.writeXML(xml, path);
    }
  }
 
 
  namespace InlineMesonMatElemColorVecEnv 
  { 
    // Anonymous namespace for registration
    namespace
    {
      AbsInlineMeasurement* createMeasurement(XMLReader& xml_in, 
                                              const std::string& path) 
      {
        return new InlineMeas(Params(xml_in, path));
      }
 
      //! Local registration flag
      bool registered = false;
    }
 
    const std::string name = "MESON_MATELEM_COLORVEC";
 
    //! Register all the factories
    bool registerAll() 
    {
      bool success = true; 
      if (! registered)
      {
        success &= LinkSmearingEnv::registerAll();
        success &= TheInlineMeasurementFactory::Instance().registerObject(name, createMeasurement);
        registered = true;
      }
      return success;
    }
 
 
    //! Anonymous namespace
    /*! Diagnostic stuff */
    namespace
    {
      StandardOutputStream& operator<<(StandardOutputStream& os, const multi1d<int>& d)
      {
        if (d.size() > 0)
        {
          os << d[0];
 
          for(int i=1; i < d.size(); ++i)
            os << " " << d[i];
        }
 
        return os;
      }
    }
 
 
    //----------------------------------------------------------------------------
    // Param stuff
    Params::Params()
    { 
      frequency = 0; 
      param.mom2_min = 0;
      param.mom2_max = 0;
      param.mom_list.resize(0);
    }
 
    Params::Params(XMLReader& xml_in, const std::string& path) 
    {
      try 
      {
        XMLReader paramtop(xml_in, path);
 
        if (paramtop.count("Frequency") == 1)
          read(paramtop, "Frequency", frequency);
        else
          frequency = 1;
 
        // Read program parameters
        read(paramtop, "Param", param);
 
        // Read in the output propagator/source configuration info
        read(paramtop, "NamedObject", named_obj);
 
        // Possible alternate XML file pattern
        if (paramtop.count("xml_file") != 0) 
        {
          read(paramtop, "xml_file", xml_file);
        }
      }
      catch(const std::string& e) 
      {
        QDPIO::cerr << __func__ << ": Caught Exception reading XML: " << e << std::endl;
        QDP_abort(1);
      }
    }
 
 
    void
    Params::writeXML(XMLWriter& xml_out, const std::string& path) const
    {
      push(xml_out, path);
    
      // Parameters for source construction
      write(xml_out, "Param", param);
 
      // Write out the output propagator/source configuration info
      write(xml_out, "NamedObject", named_obj);
 
      pop(xml_out);
    }
 
 
    //----------------------------------------------------------------------------
    //! Meson operator
    struct KeyMesonElementalOperator_t
    {
      int                t_slice;      /*!< Meson operator time slice */
      multi1d<int>       displacement; /*!< Displacement dirs of right colorstd::vector */
      multi1d<int>       mom;          /*!< D-1 momentum of this operator */
    };
 
    //! Meson operator
    struct ValMesonElementalOperator_t
    {
      int                type_of_data; /*!< Flag indicating type of data (maybe trivial) */
      multi2d<ComplexD>  op;          /*!< Colorstd::vector source and sink with momentum projection */
    };
 
 
    //----------------------------------------------------------------------------
    //! Holds key and value as temporaries
    struct KeyValMesonElementalOperator_t
    {
      SerialDBKey<KeyMesonElementalOperator_t>  key;
      SerialDBData<ValMesonElementalOperator_t> val;
    };
 
 
    //----------------------------------------------------------------------------
    //! KeyMesonElementalOperator reader
    void read(BinaryReader& bin, KeyMesonElementalOperator_t& param)
    {
      read(bin, param.t_slice);
      read(bin, param.displacement);
      read(bin, param.mom);
    }
 
    //! MesonElementalOperator write
    void write(BinaryWriter& bin, const KeyMesonElementalOperator_t& param)
    {
      write(bin, param.t_slice);
      write(bin, param.displacement);
      write(bin, param.mom);
    }
 
    //! MesonElementalOperator reader
    void read(XMLReader& xml, const std::string& path, KeyMesonElementalOperator_t& param)
    {
      XMLReader paramtop(xml, path);
    
      read(paramtop, "t_slice", param.t_slice);
      read(paramtop, "displacement", param.displacement);
      read(paramtop, "mom", param.mom);
    }
 
    //! MesonElementalOperator writer
    void write(XMLWriter& xml, const std::string& path, const KeyMesonElementalOperator_t& param)
    {
      push(xml, path);
 
      write(xml, "t_slice", param.t_slice);
      write(xml, "displacement", param.displacement);
      write(xml, "mom", param.mom);
 
      pop(xml);
    }
 
 
    //----------------------------------------------------------------------------
    //! MesonElementalOperator reader
    void read(BinaryReader& bin, ValMesonElementalOperator_t& param)
    {
      read(bin, param.type_of_data);
 
      int n;
      read(bin, n);    // the size is always written, even if 0
      param.op.resize(n,n);
  
      for(int i=0; i < n; ++i)
      {
        for(int j=0; j < n; ++j)
        {
          read(bin, param.op(i,j));
        }
      }
    }
 
    //! MesonElementalOperator write
    void write(BinaryWriter& bin, const ValMesonElementalOperator_t& param)
    {
      write(bin, param.type_of_data);
 
      int n = param.op.size1();  // all sizes the same
      write(bin, n);
      for(int i=0; i < n; ++i)
      {
        for(int j=0; j < n; ++j)
        {
          write(bin, param.op(i,j));
        }
      }
    }
 
 
    //----------------------------------------------------------------------------
    //! Normalize just one displacement array
    multi1d<int> normDisp(const multi1d<int>& orig)
    {
      START_CODE();
 
      multi1d<int> disp;
      multi1d<int> empty; 
      multi1d<int> no_disp(1); no_disp[0] = 0;
 
      // NOTE: a no-displacement is recorded as a zero-length array
      // Convert a length one array with no displacement into a no-displacement array
      if (orig.size() == 1)
      {
        if (orig == no_disp)
          disp = empty;
        else
          disp = orig;
      }
      else
      {
        disp = orig;
      }
 
      END_CODE();
 
      return disp;
    } // void normDisp
 
 
    //-------------------------------------------------------------------------------
    // Function call
    void 
    InlineMeas::operator()(unsigned long update_no,
                           XMLWriter& xml_out) 
    {
      // If xml file not empty, then use alternate
      if (params.xml_file != "")
      {
        std::string xml_file = makeXMLFileName(params.xml_file, update_no);
 
        push(xml_out, "MesonMatElemColorVec");
        write(xml_out, "update_no", update_no);
        write(xml_out, "xml_file", xml_file);
        pop(xml_out);
 
        XMLFileWriter xml(xml_file);
        func(update_no, xml);
      }
      else
      {
        func(update_no, xml_out);
      }
    }
 
 
    // Function call
    void 
    InlineMeas::func(unsigned long update_no,
                     XMLWriter& xml_out) 
    {
      START_CODE();
 
      StopWatch snoop;
      snoop.reset();
      snoop.start();
 
      
      StopWatch swiss;
                        
      // Test and grab a reference to the gauge field
      XMLBufferWriter gauge_xml;
      try
      {
        TheNamedObjMap::Instance().getData< multi1d<LatticeColorMatrix> >(params.named_obj.gauge_id);
        TheNamedObjMap::Instance().get(params.named_obj.gauge_id).getRecordXML(gauge_xml);
 
        // NB We are just checking this is here.
        TheNamedObjMap::Instance().getData< Handle< MapObject<int,EVPair<LatticeColorVector> > > >(params.named_obj.colorvec_id);
      }
      catch( std::bad_cast ) 
      {
        QDPIO::cerr << name << ": caught dynamic cast error" << std::endl;
        QDP_abort(1);
      }
      catch (const std::string& e) 
      {
        QDPIO::cerr << name << ": std::map call failed: " << e << std::endl;
        QDP_abort(1);
      }
 
      // Cast should be valid now
      const multi1d<LatticeColorMatrix>& u = 
        TheNamedObjMap::Instance().getData< multi1d<LatticeColorMatrix> >(params.named_obj.gauge_id);
 
      const MapObject<int,EVPair<LatticeColorVector> >& eigen_source = 
        *(TheNamedObjMap::Instance().getData< Handle< MapObject<int,EVPair<LatticeColorVector> > > >(params.named_obj.colorvec_id));
 
      // Sanity check
      if (params.param.num_vecs > eigen_source.size())
      {
        QDPIO::cerr << name << ": number of available eigenvectors is too small\n";
        QDP_abort(1);
      }
 
      push(xml_out, "MesonMatElemColorVec");
      write(xml_out, "update_no", update_no);
 
      QDPIO::cout << name << ": Meson color-std::vector matrix element" << std::endl;
 
      proginfo(xml_out);    // Print out basic program info
 
      // Write out the input
      params.writeXML(xml_out, "Input");
 
      // Write out the config info
      write(xml_out, "Config_info", gauge_xml);
 
      push(xml_out, "Output_version");
      write(xml_out, "out_version", 1);
      pop(xml_out);
 
      //First calculate some gauge invariant observables just for info.
      //This is really cheap.
      MesPlq(xml_out, "Observables", u);
 
      //
      // Initialize the slow Fourier transform phases
      //
      SftMom phases(params.param.mom2_max, false, params.param.decay_dir);
 
      //
      // If a list of momenta has been specified only need phases corresponding to these
      //
      if (params.param.mom_list.size() > 0)
      {
        int num_mom = params.param.mom_list.size();
        int mom_size = params.param.mom_list[0].size();
        multi2d<int> moms(num_mom,mom_size);
        for(int i = 0; i < num_mom; i++)
          {
            moms[i] = params.param.mom_list[i];
          }
        SftMom temp_phases(moms, params.param.decay_dir);
        phases = temp_phases;
        params.param.mom2_min = 0;
      }
 
      //
      // Smear the gauge field if needed
      //
      multi1d<LatticeColorMatrix> u_smr = u;
 
      try
      {
        std::istringstream  xml_l(params.param.link_smearing.xml);
        XMLReader  linktop(xml_l);
        QDPIO::cout << "Link smearing type = " << params.param.link_smearing.id << std::endl;
        
        
        Handle< LinkSmearing >
          linkSmearing(TheLinkSmearingFactory::Instance().createObject(params.param.link_smearing.id,
                                                                       linktop, 
                                                                       params.param.link_smearing.path));
 
        (*linkSmearing)(u_smr);
      }
      catch(const std::string& e) 
      {
        QDPIO::cerr << name << ": Caught Exception link smearing: " << e << std::endl;
        QDP_abort(1);
      }
 
      // Record the smeared observables
      MesPlq(xml_out, "Smeared_Observables", u_smr);
 
      //
      // DB storage
      //
      BinaryStoreDB< SerialDBKey<KeyMesonElementalOperator_t>, SerialDBData<ValMesonElementalOperator_t> > 
        qdp_db;
 
      // Open the file, and write the meta-data and the binary for this operator
      if (! qdp_db.fileExists(params.named_obj.meson_op_file))
      {
        XMLBufferWriter file_xml;
 
        push(file_xml, "DBMetaData");
        write(file_xml, "id", std::string("mesonElemOp"));
        write(file_xml, "lattSize", QDP::Layout::lattSize());
//      write(file_xml, "blockSize", params.param.block_size);
        write(file_xml, "decay_dir", params.param.decay_dir);
        proginfo(file_xml);    // Print out basic program info
        write(file_xml, "Params", params.param);
        write(file_xml, "Op_Info", params.param.displacement_list);
        write(file_xml, "Config_info", gauge_xml);
        write(file_xml, "Weights", getEigenValues(eigen_source, params.param.num_vecs));
        pop(file_xml);
 
        std::string file_str(file_xml.str());
        qdp_db.setMaxUserInfoLen(file_str.size());
 
        qdp_db.open(params.named_obj.meson_op_file, O_RDWR | O_CREAT, 0664);
 
        qdp_db.insertUserdata(file_str);
      }
      else
      {
        qdp_db.open(params.named_obj.meson_op_file, O_RDWR, 0664);
      }
 
 
      // Keep track of no displacements and zero momentum
      multi1d<int> no_displacement;
      multi1d<int> zero_mom(3); zero_mom = 0;
 
      //
      // Meson operators
      //
      // The creation and annihilation operators are the same without the
      // spin matrices.
      //
      QDPIO::cout << "Building meson operators" << std::endl;
 
      push(xml_out, "ElementalOps");
 
 
      // Loop over all time slices for the source. This is the same 
      // as the subsets for  phases
 
      // Loop over each operator 
      for(int l=0; l < params.param.displacement_list.size(); ++l)
      {
        StopWatch watch;
 
        QDPIO::cout << "Elemental operator: op = " << l << std::endl;
 
        // Make sure displacement is something sensible
        multi1d<int> disp = normDisp(params.param.displacement_list[l]);
 
        QDPIO::cout << "displacement = " << disp << std::endl;
 
        // Build the operator
        swiss.reset();
        swiss.start();
 
        // Big loop over the momentum projection
        for(int mom_num = 0 ; mom_num < phases.numMom() ; ++mom_num) 
        {
          if ( norm2(phases.numToMom(mom_num)) < params.param.mom2_min ) continue;
 
          // The keys for the spin and displacements for this particular elemental operator
          // No displacement for left colorstd::vector, only displace right colorstd::vector
          // Invert the time - make it an independent key
          multi1d<KeyValMesonElementalOperator_t> buf(phases.numSubsets());
          for(int t=0; t < phases.numSubsets(); ++t)
          {
            buf[t].key.key().t_slice       = t;
            buf[t].key.key().mom           = phases.numToMom(mom_num);
            buf[t].key.key().displacement  = disp; // only right colorstd::vector
            buf[t].val.data().op.resize(params.param.num_vecs,params.param.num_vecs);
 
            if ( params.param.orthog_basis && 
                 (phases.numToMom(mom_num)) == zero_mom && 
                 (disp == no_displacement) )
            {
              buf[t].val.data().type_of_data = COLORVEC_MATELEM_TYPE_ONE;
            }
            else
            {
              buf[t].val.data().type_of_data = COLORVEC_MATELEM_TYPE_GENERIC;
            }
          }
 
          for(int j = 0 ; j < params.param.num_vecs; ++j)
          {
            // Displace the right std::vector and multiply by the momentum phase
            EVPair<LatticeColorVector> tmpvec; eigen_source.get(j,tmpvec);
            LatticeColorVector shift_vec = phases[mom_num] * displace(u_smr, 
                                                                      tmpvec.eigenVector, 
                                                                      params.param.displacement_length, 
                                                                      disp);
 
            for(int i = 0 ; i <  params.param.num_vecs; ++i)
            {
              watch.reset();
              watch.start();
 
              // Contract over color indices
              // Do the relevant quark contraction
              EVPair<LatticeColorVector> tmpvec; eigen_source.get(i,tmpvec);
              LatticeComplex lop = localInnerProduct(tmpvec.eigenVector, shift_vec);
 
              // Slow fourier-transform
              multi1d<ComplexD> op_sum = sumMulti(lop, phases.getSet());
 
              watch.stop();
 
              for(int t=0; t < op_sum.size(); ++t)
              {
                buf[t].val.data().op(i,j) = op_sum[t];
              }
 
//            write(xml_out, "elem", key.key());  // debugging
            } // end for j
          } // end for i
 
          QDPIO::cout << "insert: mom= " << phases.numToMom(mom_num) << " displacement= " << disp << std::endl; 
          for(int t=0; t < phases.numSubsets(); ++t)
          {
            qdp_db.insert(buf[t].key, buf[t].val);
          }
 
        } // mom_num
 
        swiss.stop();
 
        QDPIO::cout << "Meson operator= " << l 
                    << "  time= "
                    << swiss.getTimeInSeconds() 
                    << " secs" << std::endl;
 
      } // for l
 
      pop(xml_out); // ElementalOps
 
      // Close the namelist output file XMLDAT
      pop(xml_out);     // MesonMatElemColorVector
 
      snoop.stop();
      QDPIO::cout << name << ": total time = " 
                  << snoop.getTimeInSeconds() 
                  << " secs" << std::endl;
 
      QDPIO::cout << name << ": ran successfully" << std::endl;
 
      END_CODE();
    } // func
  } // namespace InlineMesonMatElemColorVecEnv
 
  /*! @} */  // end of group hadron
 
} // namespace Chroma