Dipole/Base/DipoleEventReweight.h

0001 // -*- C++ -*-
0002 //
0003 // DipoleEventReweight.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_DipoleEventReweight_H
0010 #define Herwig_DipoleEventReweight_H
0011 //
0012 // This is the declaration of the DipoleEventReweight class.
0013 //
0014
0015 #include "ThePEG/Handlers/HandlerBase.h"
0016 #include "ThePEG/StandardModel/AlphaSBase.h"
0017
0018
0019 namespace Herwig {
0020
0021 using namespace ThePEG;
0022
0023 /**
0024  * \ingroup DipoleShower
0025  * \author Simon Platzer
0026  * \brief Reweight full final states produced by the shower
0027  *
0028  * @see \ref DipoleEventReweightInterfaces "The interfaces"
0029  * defined for DipoleEventReweight.
0030  */
0031 class DipoleEventReweight: public HandlerBase {
0032
0033 public:
0034
0035   /** @name Standard constructors and destructors. */
0036   //@{
0037   /**
0038    * The default constructor.
0039    */
0040   DipoleEventReweight();
0041
0042   /**
0043    * The destructor.
0044    */
0045   virtual ~DipoleEventReweight();
0046   //@}
0047
0048 public:
0049
0050   /**
0051    * Return the weight for the given incoming, outgoing coloured and
0052    * hard colour neutral particles, after an emission was generated
0053    */
0054   virtual double weight(const PPair& in, const PList& out, const PList& hard,
0055             Ptr<AlphaSBase>::tptr as) const = 0;
0056
0057   /**
0058    * Return the weight which is applied to a cascade only once even if there was
0059    * no emission from the cascade at all.
0060    */
0061   virtual double weightCascade(const PPair& in, const PList& out, const PList& hard,
0062                   Ptr<AlphaSBase>::tptr as) const = 0;
0063
0064   /**
0065    * Return true, if the event reweight should be applied to the hard scattering
0066    */
0067   virtual bool firstInteraction() const = 0;
0068
0069   /**
0070    * Return true, if the event reweight should be applied to secondary interactions
0071    */
0072   virtual bool secondaryInteractions() const = 0;
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
0101 // If needed, insert declarations of virtual function defined in the
0102 // InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
0103
0104
0105 private:
0106
0107   /**
0108    * The assignment operator is private and must never be called.
0109    * In fact, it should not even be implemented.
0110    */
0111   DipoleEventReweight & operator=(const DipoleEventReweight &) = delete;
0112
0113 };
0114
0115 }
0116
0117 #endif /* Herwig_DipoleEventReweight_H */