ThePEG/Cuts/OneJetCut.h

0001 // -*- C++ -*-
0002 //
0003 // OneJetCut.h is a part of ThePEG - Toolkit for HEP Event Generation
0004 // Copyright (C) 1999-2019 Leif Lonnblad
0005 // Copyright (C) 2009-2019 Simon Platzer
0006 //
0007 // ThePEG is licenced under version 3 of the GPL, see COPYING for details.
0008 // Please respect the MCnet academic guidelines, see GUIDELINES for details.
0009 //
0010 #ifndef THEPEG_OneJetCut_H
0011 #define THEPEG_OneJetCut_H
0012 //
0013 // This is the declaration of the OneJetCut class.
0014 //
0015
0016 #include "ThePEG/Cuts/MultiCutBase.h"
0017 #include "ThePEG/PDT/MatcherBase.h"
0018
0019 namespace ThePEG {
0020
0021 /**
0022  * OneJetsCut is a simple one-jet inclusive cut, requiring at least
0023  * one jet above a certain pt in a given rapidity interval.
0024  *
0025  * @see \ref OneJetCutInterfaces "The interfaces"
0026  * defined for OneJetCut.
0027  */
0028 class OneJetCut: public MultiCutBase {
0029
0030 public:
0031
0032   /**
0033    * The default constructor.
0034    */
0035   OneJetCut();
0036
0037 public:
0038
0039   /** @name Overridden virtual functions defined in the base class. */
0040   //@{
0041   /**
0042    * Return true if a set of outgoing particles with typea \a ptype
0043    * and corresponding momenta \a p passes the cuts.
0044    */
0045   virtual bool passCuts(tcCutsPtr parent, const tcPDVector & ptype,
0046             const vector<LorentzMomentum> & p) const;
0047   //@}
0048
0049   /**
0050    * Describe the currently active cuts in the log file.
0051    */
0052   virtual void describe() const;
0053
0054 public:
0055
0056   /** @name Functions used by the persistent I/O system. */
0057   //@{
0058   /**
0059    * Function used to write out object persistently.
0060    * @param os the persistent output stream written to.
0061    */
0062   void persistentOutput(PersistentOStream & os) const;
0063
0064   /**
0065    * Function used to read in object persistently.
0066    * @param is the persistent input stream read from.
0067    * @param version the version number of the object when written.
0068    */
0069   void persistentInput(PersistentIStream & is, int version);
0070   //@}
0071
0072   /**
0073    * The standard Init function used to initialize the interfaces.
0074    * Called exactly once for each class by the class description system
0075    * before the main function starts or
0076    * when this class is dynamically loaded.
0077    */
0078   static void Init();
0079
0080 protected:
0081
0082   /** @name Clone Methods. */
0083   //@{
0084   /**
0085    * Make a simple clone of this object.
0086    * @return a pointer to the new object.
0087    */
0088   virtual IBPtr clone() const;
0089
0090   /** Make a clone of this object, possibly modifying the cloned object
0091    * to make it sane.
0092    * @return a pointer to the new object.
0093    */
0094   virtual IBPtr fullclone() const;
0095   //@}
0096
0097 private:
0098
0099   /**
0100    * A matcher for unresolved partons.
0101    */
0102   Ptr<MatcherBase>::ptr unresolvedMatcher;
0103
0104   /**
0105    * The minimum pt
0106    */
0107   Energy ptMin;
0108
0109   /**
0110    * The minimum rapidity
0111    */
0112   double yMin;
0113
0114   /**
0115    * The maximum rapidity
0116    */
0117   double yMax;
0118
0119 private:
0120
0121   /**
0122    * The static object used to initialize the description of this class.
0123    * Indicates that this is a concrete class with persistent data.
0124    */
0125   static ClassDescription<OneJetCut> initOneJetCut;
0126
0127   /**
0128    * The assignment operator is private and must never be called.
0129    * In fact, it should not even be implemented.
0130    */
0131   OneJetCut & operator=(const OneJetCut &) = delete;
0132
0133 };
0134
0135 }
0136
0137 #include "ThePEG/Utilities/ClassTraits.h"
0138
0139 namespace ThePEG {
0140
0141 /** @cond TRAITSPECIALIZATIONS */
0142
0143 /** This template specialization informs ThePEG about the
0144  *  base classes of OneJetCut. */
0145 template <>
0146 struct BaseClassTrait<OneJetCut,1> {
0147   /** Typedef of the first base class of OneJetCut. */
0148   typedef MultiCutBase NthBase;
0149 };
0150
0151 /** This template specialization informs ThePEG about the name of
0152  *  the OneJetCut class and the shared object where it is defined. */
0153 template <>
0154 struct ClassTraits<OneJetCut>
0155   : public ClassTraitsBase<OneJetCut> {
0156   /** Return a platform-independent class name */
0157   static string className() { return "ThePEG::OneJetCut"; }
0158   /** Return the name of the shared library be loaded to get
0159    *  access to the OneJetCut class and every other class it uses
0160    *  (except the base class). */
0161   static string library() { return "JetCuts.so"; }
0162 };
0163
0164 /** @endcond */
0165
0166 }
0167
0168 #endif /* THEPEG_OneJetCut_H */