Matchbox/Cuts/FrixionePhotonSeparationCut.h

0001 // -*- C++ -*-
0002 //
0003 // FrixionePhotonSeparationCut.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_FrixionePhotonSeparationCut_H
0010 #define Herwig_FrixionePhotonSeparationCut_H
0011 //
0012 // This is the declaration of the FrixionePhotonSeparationCut class.
0013 //
0014
0015 #include "ThePEG/Cuts/MultiCutBase.h"
0016 #include "ThePEG/PDT/MatcherBase.h"
0017
0018 namespace Herwig {
0019
0020 using namespace ThePEG;
0021
0022 /**
0023  * \ingroup Matchbox
0024  * \author Michael Rauch
0025  *
0026  * \brief This class implements a cut on legoplot and rapidity separation
0027  *
0028  * @see \ref FrixionePhotonSeparationCutInterfaces "The interfaces"
0029  * defined for FrixionePhotonSeparationCut.
0030  */
0031 class FrixionePhotonSeparationCut: public MultiCutBase {
0032
0033 public:
0034
0035   /** @name Standard constructors and destructors. */
0036   //@{
0037   /**
0038    * The default constructor.
0039    */
0040   FrixionePhotonSeparationCut() :  theDeltaZero(0.0), theExponentn(1.0), theEfficiency(0.0), theCutType(1) {}
0041   //@}
0042
0043 public:
0044
0045   /** @name Overridden virtual functions defined in the base class. */
0046   //@{
0047   /**
0048    * Return true if a pair of particles with type \a pitype and \a
0049    * pjtype and momenta \a pi and \a pj respectively passes the
0050    * cuts. \a inci and \a inj indicates if the corresponding particles
0051    * are incoming.
0052    */
0053   virtual bool passCuts(tcCutsPtr, const tcPDVector & ptype,
0054                     const vector<LorentzMomentum> & p) const;
0055   //@}
0056
0057   /**
0058    * Describe the currently active cuts in the log file.
0059    */
0060   virtual void describe() const;
0061
0062   /**
0063    * Return the matcher for particles to isolate on.
0064    */
0065   Ptr<MatcherBase>::tptr matcher() const { return theMatcher; }
0066
0067 public:
0068
0069   /** @name Functions used by the persistent I/O system. */
0070   //@{
0071   /**
0072    * Function used to write out object persistently.
0073    * @param os the persistent output stream written to.
0074    */
0075   void persistentOutput(PersistentOStream & os) const;
0076
0077   /**
0078    * Function used to read in object persistently.
0079    * @param is the persistent input stream read from.
0080    * @param version the version number of the object when written.
0081    */
0082   void persistentInput(PersistentIStream & is, int version);
0083   //@}
0084
0085   /**
0086    * The standard Init function used to initialize the interfaces.
0087    * Called exactly once for each class by the class description system
0088    * before the main function starts or
0089    * when this class is dynamically loaded.
0090    */
0091   static void Init();
0092
0093 protected:
0094
0095   /** @name Clone Methods. */
0096   //@{
0097   /**
0098    * Make a simple clone of this object.
0099    * @return a pointer to the new object.
0100    */
0101   virtual IBPtr clone() const;
0102
0103   /** Make a clone of this object, possibly modifying the cloned object
0104    * to make it sane.
0105    * @return a pointer to the new object.
0106    */
0107   virtual IBPtr fullclone() const;
0108   //@}
0109
0110 private:
0111
0112   /**
0113    * The maximal legoplot separation where partons are included in the criterium
0114    */
0115   double theDeltaZero;
0116
0117   /**
0118    * The exponent n of the algorithm
0119    */
0120   double theExponentn;
0121
0122   /**
0123    * The efficiency epsilon of the algorithm
0124    */
0125   double theEfficiency;
0126
0127   /**
0128    * The cut type of the algorithm
0129    */
0130   int theCutType;
0131
0132   /**
0133    * A matcher for particles to isolate on.
0134    */
0135   Ptr<MatcherBase>::ptr theMatcher;
0136
0137 private:
0138
0139   /**
0140    * The assignment operator is private and must never be called.
0141    * In fact, it should not even be implemented.
0142    */
0143   FrixionePhotonSeparationCut & operator=(const FrixionePhotonSeparationCut &) = delete;
0144
0145 };
0146
0147 }
0148
0149 #endif /* Herwig_FrixionePhotonSeparationCut_H */