aniso_sym_temporal_gaugeact.h

Go to the documentation of this file.

// -*- C++ -*-
/*! \file
 *  \brief Temporal Part of Tree Level LW gauge action
 *
 */
 
#ifndef __aniso_sym_temporal_gaugeact_h__
#define __aniso_sym_temporal_gaugeact_h__
 
#include "gaugeact.h"
#include "gaugebc.h"
#include "actions/gauge/gaugeacts/plaq_gaugeact.h"
#include "actions/gauge/gaugeacts/rect_gaugeact.h"
#include "actions/gauge/gaugeacts/aniso_sym_gaugeact_params.h"
 
 
namespace Chroma
{
 
  /*! @ingroup gaugeacts */
  namespace AnisoSymTemporalGaugeActEnv 
  {
    extern const std::string name;
    bool registerAll();
  }
 
  //! Temporal anisotropic Symanzik improved gauge action
  /*! \ingroup gaugeacts
   *
   *   Contains space-space plaquette and space space rectangle terms
   *   only. Useful for when one wants to split the spatial and temporal
   *   parts of the general Symanzik gauge action onto different timescales
   *   in an (R)HMC simulation.
   */
 
  class AnisoSymTemporalGaugeAct : public LinearGaugeAction
  {
  public:
    // Typedefs to save typing
    typedef multi1d<LatticeColorMatrix>  P;
    typedef multi1d<LatticeColorMatrix>  Q;
 
    //! Read beta from a param struct
    AnisoSymTemporalGaugeAct(Handle< CreateGaugeState<P,Q> > cgs_, 
                          const AnisoSymGaugeActParams& p) :
    cgs(cgs_),  param(p) {init();}
 
    //! Is anisotropy used?
    bool anisoP() const {return param.aniso.anisoP; }
 
    //! Anisotropy factor
    const Real anisoFactor() const {return param.aniso.xi_0;}
 
    //! Anisotropic direction
    int tDir() const {return param.aniso.t_dir;}
 
    //! Return the set on which the gauge action is defined
    /*! Defined on the even-off (red/black) set */
    const Set& getSet() const {return rb;}
 
    //! Compute staple
    /*! Default version. Derived class should override this if needed. */
    void staple(LatticeColorMatrix& result,
                const Handle< GaugeState<P,Q> >& state,
                int mu, int cb) const
      {
        QDPIO::cerr << "This function is not implemented" << std::endl;
        QDP_abort(1);
 
      }
 
    //! Compute dS/dU
    void deriv(multi1d<LatticeColorMatrix>& result,
               const Handle< GaugeState<P,Q> >& state) const;
 
    //! Compute the actions
    Double S(const Handle< GaugeState<P,Q> >& state) const;
 
 
    //! Produce a gauge create state object
    const CreateGaugeState<P,Q>& getCreateState() const {return *cgs; }
 
    //! Destructor is automatic
    ~AnisoSymTemporalGaugeAct() {}
 
    // Accessors -- non mutable members.
    const Real getBeta(void) const { return param.beta; }
    
    const Real getUS(void) const { return param.u_s; }
    
    const Real getUT(void) const { return param.u_t; }
 
  protected:
    //! Private initializer
    void init(void);
 
    //! Hide assignment
    void operator=(const AnisoSymTemporalGaugeAct& a) {}
 
  private:
    const Handle< CreateGaugeState<P,Q> > cgs;
    AnisoSymGaugeActParams    param;    /*!< The couplings and anisotropy*/
    Real plaq_c_t;    /*!< Temporal plaquette coupling */
    Real rect_c_t_2;  /*!< Temporal \mu x 2\nu rectangle coupling */
    
  };
 
}
 
 
#endif