EIC code displayed by LXR master/​include/​ThePEG/​Handlers/​SubProcessHandler.h	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2026-08-06 09:38:23

 // -*- C++ -*-
 //
 // SubProcessHandler.h is a part of ThePEG - Toolkit for HEP Event Generation
 // Copyright (C) 1999-2019 Leif Lonnblad
 //
 // ThePEG is licenced under version 3 of the GPL, see COPYING for details.
 // Please respect the MCnet academic guidelines, see GUIDELINES for details.
 //
 #ifndef ThePEG_SubProcessHandler_H
 #define ThePEG_SubProcessHandler_H
 // This is the declaration of the SubProcessHandler class.
 
 #include "ThePEG/Config/ThePEG.h"
 #include "ThePEG/Utilities/Interval.h"
 #include "ThePEG/Handlers/HandlerGroup.h"
 #include "ThePEG/Handlers/HandlerBase.h"
 #include "ThePEG/MatrixElement/MEBase.fh"
 #include "ThePEG/Cuts/Cuts.fh"
 #include "SubProcessHandler.fh"
 
 namespace ThePEG {
 
 /**
  * The SubProcessHandler class is used to handle a set of MEBase
  * objects together with a PartonExtractor. It is used by the
  * StandardEventHandler to group together different ways of extracting
  * partons from incoming particles with associated hard parton-parton
  * matrix elements.
  *
  * Just as the EventHandler class, a SubProcessHandler keeps a full
  * set of <code>HandlerGroup</code>s, which may be filled with
  * defaults which overrides the ones specified in the EventHandler in
  * each event the SubProcessHandler is chosen.
  *
  * The SubProcessHandler has also a Cuts object which is
  * responsible for restricting the kinematics of the sub-process and
  * produced collision. This object takes precedence over the one in
  * the EventHandler in each event the SubProcessHandler is chosen.
  *
  * @see \ref SubProcessHandlerInterfaces "The interfaces"
  * defined for SubProcessHandler.
  * @see MEBase
  * @see PartonExtractor
  * @see EventHandler
  * @see StandardEventHandler
  * @see HandlerGroup
  * @see Cuts
  */
 class SubProcessHandler: public HandlerBase {
 
 public:
 
   /** A vector of HandlerGroup pointers. */
   typedef vector<HandlerGroupBase *> GroupVector;
 
   /** A vector of ReweightBase pointers. */
   typedef vector<ReweightPtr> ReweightVector;
 
 public:
 
   /** @name Standard constructors and destructors. */
   //@{
   /**
    * Default constructor.
    */
   SubProcessHandler();
 
   /**
    * Copy-constructor.
    */
   SubProcessHandler(const SubProcessHandler &);
 
   /**
    * Default destructor.
    */
   virtual ~SubProcessHandler();
   //@}
 
 public:
 
   /** @name Access objects assigned to the SubProcessHandler. */
   //@{
   /**
    * Return a pointer to the parton extractor used.
    */
   tPExtrPtr pExtractor() const { return thePartonExtractor; }
 
   /**
    * Return a reference to the vector of parton matrix elements used.
    */
   const MEVector & MEs() const { return theMEs; }
 
   /**
    * Return a pointer to the kinematical cuts used.
    */
   tCutsPtr cuts() const { return theCuts; }
 
   /**
    * Return a pointer (possibly null) to the assigned main
    * CascadeHandler to be used as CKKW-reweighter.
    */
   tCascHdlPtr CKKWHandler() const;
 
   /**
    * Access a step handler group.
    */
   const HandlerGroupBase & handlerGroup(Group::Handler) const;
 
   /**
    * Access the step handler groups.
    */
   const GroupVector & groups() const { return theGroups; }
 
   /**
    * Return a reference to the vector of parton matrix elements used.
    */
   MEVector & MEs() { return theMEs; }
   //@}
 
 public:
 
   /** @name Functions used by the persistent I/O system. */
   //@{
   /**
    * Function used to write out object persistently.
    * @param os the persistent output stream written to.
    */
   void persistentOutput(PersistentOStream & os) const;
 
   /**
    * Function used to read in object persistently.
    * @param is the persistent input stream read from.
    * @param version the version number of the object when written.
    */
   void persistentInput(PersistentIStream & is, int version);
   //@}
 
   /**
    * Standard Init function used to initialize the interface.
    */
   static void Init();
 
 protected:
 
   /** @name Clone Methods. */
   //@{
   /**
    * Make a simple clone of this object.
    * @return a pointer to the new object.
    */
   virtual IBPtr clone() const;
 
   /** Make a clone of this object, possibly modifying the cloned object
    * to make it sane.
    * @return a pointer to the new object.
    */
   virtual IBPtr fullclone() const;
   //@}
 
   /** @name Standard Interfaced functions. */
   //@{
 
   /**
    * Initialize this object after the setup phase before saving an
    * EventGenerator to disk.
    * @throws InitException if object could not be initialized properly.
    */
   virtual void doinit();
 
   /**
    * Initialize this object. Called in the run phase just before
    * a run begins.
    */
   virtual void doinitrun();
   //@}
 
 private:
 
   /**
    * Setup the step handler groups.
    */
   void setupGroups();
 
 private:
 
   /**
    * The pointer to the parton extractor used.
    */
   PExtrPtr thePartonExtractor;
 
   /**
    * The vector of partonic matrix elements to be used.
    */
   MEVector theMEs;
 
   /**
    * The pointer to the kinematical cuts used.
    */
   CutsPtr theCuts;
 
   /**
    * The SubProcessHandler group.
    */
   HandlerGroup<SubProcessHandler> theSubprocessGroup;
 
   /**
    * The CascadeHandler group.
    */
   HandlerGroup<CascadeHandler> theCascadeGroup;
 
   /**
    * The MultipleInteractionHandler group.
    */
   HandlerGroup<MultipleInteractionHandler> theMultiGroup;
 
   /**
    * The HadronizationHandler group.
    */
   HandlerGroup<HadronizationHandler> theHadronizationGroup;
 
   /**
    * The DecayHandler group.
    */
   HandlerGroup<DecayHandler> theDecayGroup;
 
   /**
    * The step handler groups.
    */
   GroupVector theGroups;
 
   /**
    * The pre- and re-weight objects modifying all matrix element in
    * this sub-process hander.
    */
   ReweightVector reweights;
   /**
    * The pre- and re-weight objects modifying all matrix element in
    * this sub-process hander.
    */
   ReweightVector preweights;
 
 private:
 
   ThePEG_DECLARE_PREPOST_GROUP(SubProcessHandler,Post);
   ThePEG_DECLARE_GROUPINTERFACE(CascadeHandler,CascHdlPtr);
   ThePEG_DECLARE_GROUPINTERFACE(MultipleInteractionHandler,MIHdlPtr);
   ThePEG_DECLARE_GROUPINTERFACE(HadronizationHandler,HadrHdlPtr);
   ThePEG_DECLARE_GROUPINTERFACE(DecayHandler,DecayHdlPtr);
 
   /**
    * Describe a concreta class with persistent data.
    */
   static ClassDescription<SubProcessHandler> initSubProcessHandler;
 
 private:
 
   /**
    * Private and non-existent assignment operator.
    */
   const SubProcessHandler & operator=(const SubProcessHandler &) = delete;
 
 };
 
 /** @cond TRAITSPECIALIZATIONS */
 
 /** This template specialization informs ThePEG about the
  *  base classes of SubProcessHandler. */
 template <>
 struct BaseClassTrait<SubProcessHandler,1>: public ClassTraitsType {
   /** Typedef of the first base class of SubProcessHandler. */
   typedef HandlerBase NthBase;
 };
 
 /** This template specialization informs ThePEG about the name of
  *  the SubProcessHandler class and the shared object where it is defined. */
 template <>
 struct ClassTraits<SubProcessHandler>:
     public ClassTraitsBase<SubProcessHandler> {
   /** Return a platform-independent class name */
   static string className() { return "ThePEG::SubProcessHandler"; }
 };
 
 /** @endcond */
 
 }
 
 #endif /* ThePEG_SubProcessHandler_H */

This page was automatically generated by the 2.3.7 LXR engine. The LXR team