QTilde/Base/ShowerVeto.h

0001 // -*- C++ -*-
0002 //
0003 // ShowerVeto.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_ShowerVeto_H
0010 #define HERWIG_ShowerVeto_H
0011 //
0012 // This is the declaration of the ShowerVeto class.
0013 //
0014
0015 #include "ThePEG/Interface/Interfaced.h"
0016 #include "ShowerVeto.fh"
0017 #include "Herwig/Shower/QTilde/ShowerConfig.h"
0018 #include "Herwig/Shower/QTilde/Base/ShowerParticle.fh"
0019 #include "Herwig/Shower/QTilde/Base/ShowerProgenitor.fh"
0020 #include "Herwig/Shower/QTilde/Base/ShowerTree.fh"
0021
0022 namespace Herwig {
0023
0024 struct Branching;
0025
0026 using namespace ThePEG;
0027
0028 /**\ingroup Shower
0029  * Exception class for vetoing a showering
0030  */
0031 struct VetoShower { };
0032
0033 /**\ingroup Shower
0034  * ShowerVeto is a general interface for performing
0035  * vetoes during showering.
0036  *
0037  * @see \ref ShowerVetoInterfaces "The interfaces"
0038  * defined for ShowerVeto.
0039  */
0040 class ShowerVeto: public Interfaced {
0041
0042 public:
0043
0044   /**
0045    * Define types of ShowerVetoes
0046    */
0047   enum ShowerVetoType {
0048
0049     /**
0050      * Throw away emission, if veto encountered. Set the scale to
0051      * the scale of vetoed emission.
0052      */
0053     Emission = 1,
0054
0055     /**
0056      * Throw away showering
0057      */
0058     Shower,
0059
0060     /**
0061      * Throw away event
0062      */
0063     Event
0064   };
0065
0066 public:
0067
0068   /**
0069    * Constructor giving the behaviour of this veto
0070    */
0071   ShowerVeto (ShowerVetoType vetoType) : _vetoType(vetoType) {}
0072
0073   /**
0074    * Return the type of this veto
0075    */
0076   ShowerVetoType vetoType () const {return _vetoType;}
0077
0078 public:
0079
0080   /** @name Functions used by the persistent I/O system. */
0081   //@{
0082   /**
0083    * Function used to write out object persistently.
0084    * @param os the persistent output stream written to.
0085    */
0086   void persistentOutput(PersistentOStream & os) const;
0087
0088   /**
0089    * Function used to read in object persistently.
0090    * @param is the persistent input stream read from.
0091    * @param version the version number of the object when written.
0092    */
0093   void persistentInput(PersistentIStream & is, int version);
0094   //@}
0095
0096   /**
0097    * The standard Init function used to initialize the interfaces.
0098    * Called exactly once for each class by the class description system
0099    * before the main function starts or
0100    * when this class is dynamically loaded.
0101    */
0102   static void Init();
0103
0104 public:
0105
0106   /**
0107    * Return true, if the selected emission off the given
0108    * particle and progenitor is vetoed.
0109    */
0110   virtual bool vetoTimeLike (tcShowerProgenitorPtr, tcShowerParticlePtr,
0111                  const Branching&,tcShowerTreePtr) = 0;
0112
0113   /**
0114    * Return true, if the selected emission off the given
0115    * particle and progenitor is vetoed.
0116    */
0117   virtual bool vetoSpaceLike (tcShowerProgenitorPtr, tcShowerParticlePtr,
0118                   const Branching&,tcShowerTreePtr) = 0;
0119
0120 private:
0121
0122   /**
0123    * The assignment operator is private and must never be called.
0124    * In fact, it should not even be implemented.
0125    */
0126   ShowerVeto & operator=(const ShowerVeto &) = delete;
0127
0128 private:
0129
0130   /**
0131    * The type of this veto.
0132    */
0133   ShowerVetoType _vetoType;
0134
0135 };
0136
0137 }
0138
0139 #endif /* HERWIG_ShowerVeto_H */