Models/General/BSMWidthGenerator.h

0001 // -*- C++ -*-
0002 //
0003 // BSMWidthGenerator.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_BSMWidthGenerator_H
0010 #define HERWIG_BSMWidthGenerator_H
0011 //
0012 // This is the declaration of the BSMWidthGenerator class.
0013 //
0014
0015 #include "Herwig/PDT/GenericWidthGenerator.h"
0016 #include "Herwig/Decay/General/GeneralTwoBodyDecayer.fh"
0017 #include "BSMWidthGenerator.fh"
0018
0019 namespace Herwig {
0020 using namespace ThePEG;
0021
0022 /**
0023  * This class is designed to be able to calculate the running
0024  * width for a BSM particle given the decay mode and partial width
0025  * calculated from the decayer.
0026  *
0027  * @see \ref BSMWidthGeneratorInterfaces "The interfaces"
0028  * defined for BSMWidthGenerator.
0029  */
0030 class BSMWidthGenerator: public GenericWidthGenerator {
0031
0032 public:
0033
0034   /**
0035    * The default constructor.
0036    */
0037   BSMWidthGenerator() : theModes(0) {}
0038
0039   /** @name Functions used by the persistent I/O system. */
0040   //@{
0041   /**
0042    * Function used to write out object persistently.
0043    * @param os the persistent output stream written to.
0044    */
0045   void persistentOutput(PersistentOStream & os) const;
0046
0047   /**
0048    * Function used to read in object persistently.
0049    * @param is the persistent input stream read from.
0050    * @param version the version number of the object when written.
0051    */
0052   void persistentInput(PersistentIStream & is, int version);
0053   //@}
0054
0055   /**
0056    * The standard Init function used to initialize the interfaces.
0057    * Called exactly once for each class by the class description system
0058    * before the main function starts or
0059    * when this class is dynamically loaded.
0060    */
0061   static void Init();
0062
0063 protected:
0064
0065   /**
0066    * Perform the set up for a mode in classes inheriting from this one
0067    * @param mode The decay mode
0068    * @param decayer The decayer for the mode.
0069    * @param imode The number of the mode.
0070    */
0071   virtual void setupMode(tcDMPtr mode, tDecayIntegratorPtr decayer,
0072              unsigned int imode);
0073
0074   /**
0075    * The \f$1\to2\f$ width for outgoing particles which can be off-shell.
0076    * @param iloc The location of the mode in the list.
0077    * @param m0 The mass of the decaying particle.
0078    * @param m1 The mass of the first outgoing particle.
0079    * @param m2 The mass of the second outgoing particle.
0080    * @return The partial width.
0081    */
0082   virtual Energy partial2BodyWidth(int iloc,Energy m0,Energy m1,Energy m2) const;
0083
0084 protected:
0085
0086   /** @name Clone Methods. */
0087   //@{
0088   /**
0089    * Make a simple clone of this object.
0090    * @return a pointer to the new object.
0091    */
0092   virtual IBPtr clone() const;
0093
0094   /** Make a clone of this object, possibly modifying the cloned object
0095    * to make it sane.
0096    * @return a pointer to the new object.
0097    */
0098   virtual IBPtr fullclone() const;
0099   //@}
0100
0101 private:
0102
0103   /**
0104    * The assignment operator is private and must never be called.
0105    * In fact, it should not even be implemented.
0106    */
0107   BSMWidthGenerator & operator=(const BSMWidthGenerator &) = delete;
0108
0109 private:
0110
0111   /**
0112    * A vector decay modes with their associated decayer
0113    * cast to GeneralTwoBodyDecayer.
0114    */
0115   vector<pair<tcDMPtr, tcGeneralTwoBodyDecayerPtr> > theModes;
0116 };
0117
0118   /**
0119    * An exception class to report an error.
0120    */
0121   class BSMWidthException : public Exception {};
0122
0123 }
0124
0125 #endif /* HERWIG_BSMWidthGenerator_H */