Decay/Radiation/SOPHTY.h

0001 // -*- C++ -*-
0002 //
0003 // SOPHTY.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_SOPHTY_H
0010 #define HERWIG_SOPHTY_H
0011 //
0012 // This is the declaration of the SOPHTY class.
0013 //
0014
0015 #include "DecayRadiationGenerator.h"
0016 #include "FFDipole.fh"
0017 #include "IFDipole.fh"
0018
0019 namespace Herwig {
0020
0021 using namespace ThePEG;
0022
0023 /** \ingroup Decay
0024  *
0025  * Here is the documentation of the SOPHTY class.
0026  *
0027  * @see \ref SOPHTYInterfaces "The interfaces"
0028  * defined for SOPHTY.
0029  */
0030 class SOPHTY: public DecayRadiationGenerator {
0031
0032 public:
0033
0034   /**
0035    *  Default constructor
0036    */
0037   SOPHTY() : colouredOption_(0) {}
0038
0039   /**
0040    *  Member to generate the photons in the decay. This must be implemented
0041    *  in classes inheriting from this one to produce the radiation.
0042    * @param p The decaying particle
0043    * @param children The decay products
0044    * @param decayer The decayer for with decay mode
0045    * @return The decay products with additional radiation
0046    */
0047   virtual ParticleVector generatePhotons(const Particle & p,ParticleVector children,
0048                      tDecayIntegratorPtr decayer);
0049
0050 public:
0051
0052   /** @name Functions used by the persistent I/O system. */
0053   //@{
0054   /**
0055    * Function used to write out object persistently.
0056    * @param os the persistent output stream written to.
0057    */
0058   void persistentOutput(PersistentOStream & os) const;
0059
0060   /**
0061    * Function used to read in object persistently.
0062    * @param is the persistent input stream read from.
0063    * @param version the version number of the object when written.
0064    */
0065   void persistentInput(PersistentIStream & is, int version);
0066   //@}
0067
0068   /**
0069    * The standard Init function used to initialize the interfaces.
0070    * Called exactly once for each class by the class description system
0071    * before the main function starts or
0072    * when this class is dynamically loaded.
0073    */
0074   static void Init();
0075
0076 protected:
0077
0078   /** @name Clone Methods. */
0079   //@{
0080   /**
0081    * Make a simple clone of this object.
0082    * @return a pointer to the new object.
0083    */
0084   virtual IBPtr clone() const {return new_ptr(*this);}
0085
0086   /** Make a clone of this object, possibly modifying the cloned object
0087    * to make it sane.
0088    * @return a pointer to the new object.
0089    */
0090   virtual IBPtr fullclone() const {return new_ptr(*this);}
0091   //@}
0092
0093 private:
0094
0095   /**
0096    * The assignment operator is private and must never be called.
0097    * In fact, it should not even be implemented.
0098    */
0099   SOPHTY & operator=(const SOPHTY &) = delete;
0100
0101 private:
0102
0103   /**
0104    *  The final-final dipole
0105    */
0106   FFDipolePtr FFDipole_;
0107
0108   /**
0109    *  The initial-final dipole
0110    */
0111   IFDipolePtr IFDipole_;
0112
0113   /**
0114    *  Option for the treatment of radiation from coloured particles
0115    */
0116   unsigned int colouredOption_;
0117 };
0118
0119 }
0120
0121 #endif /* HERWIG_SOPHTY_H */