Grid/Hadrons/Modules/MSource/Momentum.hpp

/*************************************************************************************

Grid physics library, www.github.com/paboyle/Grid 

Source file: Hadrons/Modules/MSource/Momentum.hpp

Copyright (C) 2015-2019

Author: Antonin Portelli <antonin.portelli@me.com>
Author: Peter Boyle <paboyle@ph.ed.ac.uk>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

See the full license in the file "LICENSE" in the top level distribution directory
*************************************************************************************/
/*  END LEGAL */
#ifndef Hadrons_Momentum_hpp_
#define Hadrons_Momentum_hpp_

#include <Hadrons/Global.hpp>
#include <Hadrons/Module.hpp>
#include <Hadrons/ModuleFactory.hpp>

BEGIN_HADRONS_NAMESPACE

/* 
Plane Wave source
-----------------
src_x = e^i2pi/L * p *position
*/

/******************************************************************************
 *                          Plane Wave source                                 *
 ******************************************************************************/
BEGIN_MODULE_NAMESPACE(MSource)

class MomentumPar: Serializable
{
public:
//What is meant by serializable in this context
GRID_SERIALIZABLE_CLASS_MEMBERS(MomentumPar,
std::string, mom);
};


template <typename FImpl>
class TMomentum: public Module<MomentumPar>
{
public:
FERM_TYPE_ALIASES(FImpl,);
public:
// constructor
TMomentum(const std::string name);
// destructor
virtual ~TMomentum(void) {};
// dependency relation
virtual std::vector<std::string> getInput(void);
virtual std::vector<std::string> getOutput(void);
// setup
virtual void setup(void);
// execution
virtual void execute(void);
};

MODULE_REGISTER_TMP(Momentum, TMomentum<FIMPL>, MSource);
//MODULE_REGISTER_NS(Momentum, TMomentum, MSource);

/******************************************************************************
*                       TMomentum template implementation                     *
******************************************************************************/
// constructor /////////////////////////////////////////////////////////////////
template <typename FImpl>
TMomentum<FImpl>::TMomentum(const std::string name)
: Module<MomentumPar>(name)
{}

// dependencies/products ///////////////////////////////////////////////////////
template <typename FImpl>
std::vector<std::string> TMomentum<FImpl>::getInput(void)
{
    std::vector<std::string> in;
    return in;
}

template <typename FImpl>
std::vector<std::string> TMomentum<FImpl>::getOutput(void)
{
    std::vector<std::string> out = {getName()};
    return out;
}


// setup ///////////////////////////////////////////////////////////////////////
template <typename FImpl>
void TMomentum<FImpl>::setup(void)
{
    envCreateLat(PropagatorField, getName());
}


//execution//////////////////////////////////////////////////////////////////
template <typename FImpl>
void TMomentum<FImpl>::execute(void)
{
    LOG(Message) << "Generating planewave momentum source with momentum " << par().mom << std::endl;
    //what does this env do?
    PropagatorField &src = envGet(PropagatorField, getName());
    Lattice<iScalar<vInteger>> t(env().getGrid());
    LatticeComplex             C(env().getGrid()), coor(env().getGrid());
    std::vector<Real>          p;
    std::vector<Real> latt_size(GridDefaultLatt().begin(), GridDefaultLatt().end()); 
    Complex                    i(0.0,1.0);

    LOG(Message) << " " << std::endl;
    //get the momentum from parameters
    p  = strToVec<Real>(par().mom);
    C = zero;
    LOG(Message) << "momentum converted from string - " << std::to_string(p[0]) <<std::to_string(p[1]) <<std::to_string(p[2]) <<   std::to_string(p[3]) << std::endl;
    for(int mu=0;mu<4;mu++){
    Real TwoPiL =  M_PI * 2.0/ latt_size[mu];
    LatticeCoordinate(coor,mu);
    C = C +(TwoPiL * p[mu]) * coor;
    }
    C = exp(C*i);
    LOG(Message) << "exponential of pdotx taken " << std::endl;
    src = src + C;
    LOG(Message) << "source created" << std::endl;

}



END_MODULE_NAMESPACE

END_HADRONS_NAMESPACE

#endif // Hadrons_Momentum_hpp_