Dipole/Utility/IntrinsicPtGenerator.h

0001 // -*- C++ -*-
0002 //
0003 // IntrinsicPtGenerator.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_IntrinsicPtGenerator_H
0010 #define HERWIG_IntrinsicPtGenerator_H
0011 //
0012 // This is the declaration of the IntrinsicPtGenerator class.
0013 //
0014
0015 #include "ThePEG/Handlers/HandlerBase.h"
0016 #include "ThePEG/Vectors/LorentzRotation.h"
0017
0018 namespace Herwig {
0019
0020 using namespace ThePEG;
0021
0022 /**
0023  * \ingroup DipoleShower
0024  * \author Simon Platzer
0025  *
0026  * \brief IntrinsicPtGenerator generates intrinsic pt for massless
0027  * incoming partons in a shower independent way.
0028  *
0029  * @see \ref IntrinsicPtGeneratorInterfaces "The interfaces"
0030  * defined for IntrinsicPtGenerator.
0031  */
0032 class IntrinsicPtGenerator: public HandlerBase {
0033
0034 public:
0035
0036   /**
0037    * The default constructor.
0038    */
0039   IntrinsicPtGenerator();
0040
0041 public:
0042
0043   /**
0044    * Generate intrinsic pt for the given incoming
0045    * partons and return the transformation to be
0046    * applied on the final state particles. Add the
0047    * old incoming partons to the given list.
0048    */
0049   LorentzRotation kick(PPair& in,
0050                   PList& intermediates);
0051
0052 public:
0053
0054   /** @name Functions used by the persistent I/O system. */
0055   //@{
0056   /**
0057    * Function used to write out object persistently.
0058    * @param os the persistent output stream written to.
0059    */
0060   void persistentOutput(PersistentOStream & os) const;
0061
0062   /**
0063    * Function used to read in object persistently.
0064    * @param is the persistent input stream read from.
0065    * @param version the version number of the object when written.
0066    */
0067   void persistentInput(PersistentIStream & is, int version);
0068   //@}
0069
0070   /**
0071    * The standard Init function used to initialize the interfaces.
0072    * Called exactly once for each class by the class description system
0073    * before the main function starts or
0074    * when this class is dynamically loaded.
0075    */
0076   static void Init();
0077
0078 protected:
0079
0080   /** @name Clone Methods. */
0081   //@{
0082   /**
0083    * Make a simple clone of this object.
0084    * @return a pointer to the new object.
0085    */
0086   virtual IBPtr clone() const;
0087
0088   /** Make a clone of this object, possibly modifying the cloned object
0089    * to make it sane.
0090    * @return a pointer to the new object.
0091    */
0092   virtual IBPtr fullclone() const;
0093   //@}
0094
0095
0096 // If needed, insert declarations of virtual function defined in the
0097 // InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
0098
0099 private:
0100
0101   /**
0102    * The mean of the Gaussian distribution for
0103    * the intrinsic pt of valence partons.
0104    */
0105   Energy theValenceIntrinsicPtScale;
0106
0107   /**
0108    * The mean of the Gaussian distribution for
0109    * the intrinsic pt of sea partons.
0110    */
0111   Energy theSeaIntrinsicPtScale;
0112
0113 private:
0114
0115   /**
0116    * The static object used to initialize the description of this class.
0117    * Indicates that this is a concrete class with persistent data.
0118    */
0119   static ClassDescription<IntrinsicPtGenerator> initIntrinsicPtGenerator;
0120
0121   /**
0122    * The assignment operator is private and must never be called.
0123    * In fact, it should not even be implemented.
0124    */
0125   IntrinsicPtGenerator & operator=(const IntrinsicPtGenerator &) = delete;
0126
0127 };
0128
0129 }
0130
0131 #include "ThePEG/Utilities/ClassTraits.h"
0132
0133 namespace ThePEG {
0134
0135 /** @cond TRAITSPECIALIZATIONS */
0136
0137 /** This template specialization informs ThePEG about the
0138  *  base classes of IntrinsicPtGenerator. */
0139 template <>
0140 struct BaseClassTrait<Herwig::IntrinsicPtGenerator,1> {
0141   /** Typedef of the first base class of IntrinsicPtGenerator. */
0142   typedef HandlerBase NthBase;
0143 };
0144
0145 /** This template specialization informs ThePEG about the name of
0146  *  the IntrinsicPtGenerator class and the shared object where it is defined. */
0147 template <>
0148 struct ClassTraits<Herwig::IntrinsicPtGenerator>
0149   : public ClassTraitsBase<Herwig::IntrinsicPtGenerator> {
0150   /** Return a platform-independent class name */
0151   static string className() { return "Herwig::IntrinsicPtGenerator"; }
0152   /**
0153    * The name of a file containing the dynamic library where the class
0154    * IntrinsicPtGenerator is implemented. It may also include several, space-separated,
0155    * libraries if the class IntrinsicPtGenerator depends on other classes (base classes
0156    * excepted). In this case the listed libraries will be dynamically
0157    * linked in the order they are specified.
0158    */
0159   static string library() { return "HwDipoleShower.so"; }
0160 };
0161
0162 /** @endcond */
0163
0164 }
0165
0166 #endif /* HERWIG_IntrinsicPtGenerator_H */