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

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

    Source file: ./lib/qcd/action/gauge/PlaqPlusRectangleAction.h

    Copyright (C) 2015

Author: Azusa Yamaguchi <ayamaguc@staffmail.ed.ac.uk>
Author: paboyle <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 QCD_PLAQ_PLUS_RECTANGLE_ACTION_H
#define QCD_PLAQ_PLUS_RECTANGLE_ACTION_H

namespace Grid{
  namespace QCD{
    
    ////////////////////////////////////////////////////////////////////////
    // PlaqPlusRectangleActoin
    ////////////////////////////////////////////////////////////////////////
    template<class Gimpl>
    class PlaqPlusRectangleAction : public Action<typename Gimpl::GaugeField> {
    public:

      INHERIT_GIMPL_TYPES(Gimpl);

    private:
      RealD c_plaq;
      RealD c_rect;

    public:
    PlaqPlusRectangleAction(RealD b,RealD c): c_plaq(b),c_rect(c){};
      
      virtual void refresh(const GaugeField &U, GridParallelRNG& pRNG) {}; // noop as no pseudoferms
      
      virtual RealD S(const GaugeField &U) {
	RealD vol = U._grid->gSites();

	RealD plaq = WilsonLoops<Gimpl>::avgPlaquette(U);
	RealD rect = WilsonLoops<Gimpl>::avgRectangle(U);

	RealD action=c_plaq*(1.0 -plaq)*(Nd*(Nd-1.0))*vol*0.5
	            +c_rect*(1.0 -rect)*(Nd*(Nd-1.0))*vol;

	return action;
      };

      virtual void deriv(const GaugeField &Umu,GaugeField & dSdU) {
	//extend Ta to include Lorentz indexes
	RealD factor_p = c_plaq/RealD(Nc)*0.5;
	RealD factor_r =   c_rect/RealD(Nc)*0.5;

	GridBase *grid = Umu._grid;

	std::vector<GaugeLinkField> U (Nd,grid);
	std::vector<GaugeLinkField> U2(Nd,grid);

	for(int mu=0;mu<Nd;mu++){
	  U[mu] = PeekIndex<LorentzIndex>(Umu,mu);
	  WilsonLoops<Gimpl>::RectStapleDouble(U2[mu],U[mu],mu);
	}

	GaugeLinkField dSdU_mu(grid);
	GaugeLinkField staple(grid);

	for (int mu=0; mu < Nd; mu++){

	  // Staple in direction mu

	  WilsonLoops<Gimpl>::Staple(staple,Umu,mu);

	  dSdU_mu = Ta(U[mu]*staple)*factor_p;

	  WilsonLoops<Gimpl>::RectStaple(Umu,staple,U2,U,mu);

	  dSdU_mu = dSdU_mu + Ta(U[mu]*staple)*factor_r;
	  
	  PokeIndex<LorentzIndex>(dSdU, dSdU_mu, mu);
	}

      };

    };

    // Convenience for common physically defined cases.
    //
    // RBC c1 parameterisation is not really RBC but don't have good
    // reference and we are happy to change name if prior use of this plaq coeff
    // parameterisation is made known to us. 
    template<class Gimpl>
    class RBCGaugeAction : public PlaqPlusRectangleAction<Gimpl> {
    public:
      INHERIT_GIMPL_TYPES(Gimpl);
      RBCGaugeAction(RealD beta,RealD c1) : PlaqPlusRectangleAction<Gimpl>(beta*(1.0-8.0*c1), beta*c1) {
      };
    };

    template<class Gimpl>
    class IwasakiGaugeAction : public RBCGaugeAction<Gimpl> {
    public:
      INHERIT_GIMPL_TYPES(Gimpl);
      IwasakiGaugeAction(RealD beta) : RBCGaugeAction<Gimpl>(beta,-0.331) {
      };
    };

    template<class Gimpl>
    class SymanzikGaugeAction : public RBCGaugeAction<Gimpl> {
    public:
      INHERIT_GIMPL_TYPES(Gimpl);
      SymanzikGaugeAction(RealD beta) : RBCGaugeAction<Gimpl>(beta,-1.0/12.0) {
      };
    };

    template<class Gimpl>
    class DBW2GaugeAction : public RBCGaugeAction<Gimpl> {
    public:
      INHERIT_GIMPL_TYPES(Gimpl);
      DBW2GaugeAction(RealD beta) : RBCGaugeAction<Gimpl>(beta,-1.4067) {
      };
    };

  }
}

#endif