Matchbox/Scales/MatchboxTopMassScale.h

0001 // -*- C++ -*-
0002 //
0003 // MatchboxTopMassScale.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_MatchboxTopMassScale_H
0010 #define Herwig_MatchboxTopMassScale_H
0011 //
0012 // This is the declaration of the MatchboxTopMassScale class.
0013 //
0014
0015 #include "Herwig/MatrixElement/Matchbox/Utility/MatchboxScaleChoice.h"
0016
0017 namespace Herwig {
0018
0019 using namespace ThePEG;
0020
0021 /**
0022  * \ingroup Matchbox
0023  * \author Daniel Rauch
0024  *
0025  * \brief MatchboxTopMassScale implements a scale choice related to the invariant mass
0026  *        of the top-antitop quark pair.
0027  *
0028  */
0029 class MatchboxTopMassScale: public MatchboxScaleChoice {
0030
0031 public:
0032
0033   /** @name Standard constructors and destructors. */
0034   //@{
0035   /**
0036    * The default constructor.
0037    */
0038   MatchboxTopMassScale();
0039
0040   /**
0041    * The destructor.
0042    */
0043   virtual ~MatchboxTopMassScale();
0044   //@}
0045
0046 public:
0047
0048   /**
0049    * Return the renormalization scale.
0050    */
0051   virtual Energy2 renormalizationScale() const;
0052
0053   /**
0054    * Return the factorization scale.
0055    */
0056   virtual Energy2 factorizationScale() const;
0057
0058   /**
0059    * Return the shower hard scale.
0060    */
0061   virtual Energy2 showerScale() const;
0062
0063
0064 public:
0065
0066   /** @name Functions used by the persistent I/O system. */
0067   //@{
0068   /**
0069    * Function used to write out object persistently.
0070    * @param os the persistent output stream written to.
0071    */
0072   void persistentOutput(PersistentOStream & os) const;
0073
0074   /**
0075    * Function used to read in object persistently.
0076    * @param is the persistent input stream read from.
0077    * @param version the version number of the object when written.
0078    */
0079   void persistentInput(PersistentIStream & is, int version);
0080   //@}
0081
0082   /**
0083    * The standard Init function used to initialize the interfaces.
0084    * Called exactly once for each class by the class description system
0085    * before the main function starts or
0086    * when this class is dynamically loaded.
0087    */
0088   static void Init();
0089
0090 protected:
0091
0092   /** @name Clone Methods. */
0093   //@{
0094   /**
0095    * Make a simple clone of this object.
0096    * @return a pointer to the new object.
0097    */
0098   virtual IBPtr clone() const;
0099
0100   /** Make a clone of this object, possibly modifying the cloned object
0101    * to make it sane.
0102    * @return a pointer to the new object.
0103    */
0104   virtual IBPtr fullclone() const;
0105   //@}
0106
0107 private:
0108
0109   /**
0110    * Switch to choose the definition of the shower hard scale.
0111    */
0112   unsigned int theShowerScaleMode;
0113
0114 // If needed, insert declarations of virtual function defined in the
0115 // InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
0116
0117
0118 private:
0119
0120   /**
0121    * The assignment operator is private and must never be called.
0122    * In fact, it should not even be implemented.
0123    */
0124   MatchboxTopMassScale & operator=(const MatchboxTopMassScale &) = delete;
0125
0126 };
0127
0128 }
0129
0130 #endif /* Herwig_MatchboxTopMassScale_H */