Matchbox/Dipoles/FIMqgxDipole.h

0001 // -*- C++ -*-
0002 //
0003 // FIMqgxDipole.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_FIMqgxDipole_H
0010 #define HERWIG_FIMqgxDipole_H
0011 //
0012 // This is the declaration of the FIMqgxDipole class.
0013 //
0014
0015 #include "Herwig/MatrixElement/Matchbox/Dipoles/SubtractionDipole.h"
0016
0017 namespace Herwig {
0018
0019 using namespace ThePEG;
0020
0021 /**
0022  * \ingroup Matchbox
0023  * \author Simon Platzer, Chrstian Reuschle
0024  *
0025  * \brief FIMqgxDipole implements the D_{Q,g}^a subtraction dipole,
0026  * as well as the D_{gluino,g}^a subtraction dipole.
0027  *
0028  */
0029 class FIMqgxDipole: public SubtractionDipole {
0030
0031 public:
0032
0033   /**
0034    * The default constructor.
0035    */
0036   FIMqgxDipole();
0037
0038 public:
0039
0040   /**
0041    * Return true, if this dipole can possibly handle the indicated
0042    * emitter.
0043    */
0044   virtual bool canHandleEmitter(const cPDVector& partons, int emitter) const {
0045     return emitter > 1 && abs(partons[emitter]->id()) < 7;
0046   }
0047
0048   /**
0049    * Return true, if this dipole can possibly handle the indicated
0050    * splitting.
0051    */
0052   virtual bool canHandleSplitting(const cPDVector& partons, int emitter, int emission) const {
0053     return canHandleEmitter(partons,emitter) && partons[emission]->id() == ParticleID::g;
0054   }
0055
0056   /**
0057    * Return true, if this dipole can possibly handle the indicated
0058    * spectator.
0059    */
0060   virtual bool canHandleSpectator(const cPDVector& partons, int spectator) const {
0061     return spectator < 2 && partons[spectator]->coloured();
0062   }
0063
0064   /**
0065    * Return true, if this dipole applies to the selected
0066    * configuration.
0067    */
0068   virtual bool canHandle(const cPDVector& partons,
0069              int emitter, int emission, int spectator) const;
0070
0071   /**
0072    *  How to sample the z-distribution.
0073    *  FlatZ = 1
0074    *  OneOverZ = 2
0075    *  OneOverOneMinusZ = 3
0076    *  OneOverZOneMinusZ = 4
0077    */
0078
0079   virtual int samplingZ() const {return 3;}
0080
0081   /**
0082    * Return the matrix element for the kinematical configuation
0083    * previously provided by the last call to setKinematics(), suitably
0084    * scaled by sHat() to give a dimension-less number.
0085    */
0086   virtual double me2() const;
0087
0088   /**
0089    * Return the matrix element averaged over spin correlations.
0090    */
0091   virtual double me2Avg(double ccme2) const;
0092
0093 public:
0094
0095   /** @name Functions used by the persistent I/O system. */
0096   //@{
0097   /**
0098    * Function used to write out object persistently.
0099    * @param os the persistent output stream written to.
0100    */
0101   void persistentOutput(PersistentOStream & os) const;
0102
0103   /**
0104    * Function used to read in object persistently.
0105    * @param is the persistent input stream read from.
0106    * @param version the version number of the object when written.
0107    */
0108   void persistentInput(PersistentIStream & is, int version);
0109   //@}
0110
0111   /**
0112    * The standard Init function used to initialize the interfaces.
0113    * Called exactly once for each class by the class description system
0114    * before the main function starts or
0115    * when this class is dynamically loaded.
0116    */
0117   static void Init();
0118
0119 protected:
0120
0121   /** @name Clone Methods. */
0122   //@{
0123   /**
0124    * Make a simple clone of this object.
0125    * @return a pointer to the new object.
0126    */
0127   virtual IBPtr clone() const;
0128
0129   /** Make a clone of this object, possibly modifying the cloned object
0130    * to make it sane.
0131    * @return a pointer to the new object.
0132    */
0133   virtual IBPtr fullclone() const;
0134   //@}
0135
0136
0137 // If needed, insert declarations of virtual function defined in the
0138 // InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
0139
0140
0141 private:
0142
0143   /**
0144    * The assignment operator is private and must never be called.
0145    * In fact, it should not even be implemented.
0146    */
0147   FIMqgxDipole & operator=(const FIMqgxDipole &) = delete;
0148
0149 };
0150
0151 }
0152
0153 #endif /* HERWIG_FIMqgxDipole_H */