Matchbox/Scales/MatchboxHtScale.h

0001 // -*- C++ -*-
0002 //
0003 // MatchboxHtScale.h is a part of Herwig - A multi-purpose Monte Carlo event generator
0004 // Copyright (C) 2002-2019 The Herwig Collaboration
0005 //
0006 // Herwig is licenced under version 3 of the GPL, see COPYING for details.
0007 // Please respect the MCnet academic guidelines, see GUIDELINES for details.
0008 //
0009 #ifndef Herwig_MatchboxHtScale_H
0010 #define Herwig_MatchboxHtScale_H
0011 //
0012 // This is the declaration of the MatchboxHtScale class.
0013 //
0014
0015 #include "Herwig/MatrixElement/Matchbox/Utility/MatchboxScaleChoice.h"
0016 #include "ThePEG/PDT/MatcherBase.h"
0017 #include "ThePEG/Cuts/JetFinder.h"
0018
0019 namespace Herwig {
0020
0021 using namespace ThePEG;
0022
0023 /**
0024  * \ingroup Matchbox
0025  * \author Simon Platzer
0026  *
0027  * \brief MatchboxHtScale implements scale choices related to transverse momenta.
0028  *
0029  */
0030 class MatchboxHtScale: public MatchboxScaleChoice {
0031
0032 public:
0033
0034   /** @name Standard constructors and destructors. */
0035   //@{
0036   /**
0037    * The default constructor.
0038    */
0039   MatchboxHtScale();
0040
0041   /**
0042    * The destructor.
0043    */
0044   virtual ~MatchboxHtScale();
0045   //@}
0046
0047 public:
0048
0049   /**
0050    * Return the renormalization scale. This default version returns
0051    * shat.
0052    */
0053   virtual Energy2 renormalizationScale() const;
0054
0055   /**
0056    * Return the factorization scale. This default version returns
0057    * shat.
0058    */
0059   virtual Energy2 factorizationScale() const;
0060
0061 protected:
0062
0063   /**
0064    * Initialize potential weighting factors for the given final state
0065    */
0066   virtual void initWeightFactors(const tcPDVector&, const vector<LorentzMomentum>&,
0067                  const Ptr<JetFinder>::ptr&) const {}
0068
0069   /**
0070    * Return the jet pt weighting factor for the given jet
0071    */
0072   virtual double jetPtWeight(const LorentzMomentum&) const { return 1.; }
0073
0074 public:
0075
0076   /** @name Functions used by the persistent I/O system. */
0077   //@{
0078   /**
0079    * Function used to write out object persistently.
0080    * @param os the persistent output stream written to.
0081    */
0082   void persistentOutput(PersistentOStream & os) const;
0083
0084   /**
0085    * Function used to read in object persistently.
0086    * @param is the persistent input stream read from.
0087    * @param version the version number of the object when written.
0088    */
0089   void persistentInput(PersistentIStream & is, int version);
0090   //@}
0091
0092   /**
0093    * The standard Init function used to initialize the interfaces.
0094    * Called exactly once for each class by the class description system
0095    * before the main function starts or
0096    * when this class is dynamically loaded.
0097    */
0098   static void Init();
0099
0100 protected:
0101
0102   /** @name Clone Methods. */
0103   //@{
0104   /**
0105    * Make a simple clone of this object.
0106    * @return a pointer to the new object.
0107    */
0108   virtual IBPtr clone() const;
0109
0110   /** Make a clone of this object, possibly modifying the cloned object
0111    * to make it sane.
0112    * @return a pointer to the new object.
0113    */
0114   virtual IBPtr fullclone() const;
0115   //@}
0116
0117 private:
0118
0119   /**
0120    * Reference to the jet finder
0121    */
0122   Ptr<JetFinder>::ptr theJetFinder;
0123
0124   /**
0125    * Include the transverse masses of the non-jet objects
0126    */
0127   bool theIncludeMT;
0128
0129   /**
0130    * An ovewrall scaling factor for the jet contribution
0131    */
0132   double theHTFactor;
0133
0134   /**
0135    * An ovewrall scaling factor for the non-jet contribution
0136    */
0137   double theMTFactor;
0138
0139   /**
0140    * We define jets as clustered objects with a minimum pT
0141    */
0142   Energy theScalePtCut;
0143
0144 // If needed, insert declarations of virtual function defined in the
0145 // InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
0146
0147
0148 private:
0149
0150   /**
0151    * The assignment operator is private and must never be called.
0152    * In fact, it should not even be implemented.
0153    */
0154   MatchboxHtScale & operator=(const MatchboxHtScale &) = delete;
0155
0156 };
0157
0158 }
0159
0160 #endif /* Herwig_MatchboxHtScale_H */