ThePEG/Cuts/NJetsCut.h

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