Herwig/Analysis/ParallelRunAnalysis.h

0001 // -*- C++ -*-
0002 //
0003 // ParallelRunAnalysis.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_ParallelRunAnalysis_H
0010 #define HERWIG_ParallelRunAnalysis_H
0011 //
0012 // This is the declaration of the ParallelRunAnalysis class.
0013 //
0014
0015 //#include "ThePEG/Repository/CurrentGenerator.h"
0016 #include "ThePEG/Handlers/AnalysisHandler.h"
0017 //#include "Herwig/Utilities/Histogram.h"
0018
0019 namespace Herwig {
0020
0021 using namespace ThePEG;
0022
0023 /** \ingroup Analysis
0024  * This analysis prints out information necessary for the combination of multiple
0025  * Herwig runs during the run step.
0026  *
0027  * @see \ref ParallelRunAnalysisInterfaces "The interfaces"
0028  * defined for ParallelRunAnalysis.
0029  */
0030 class ParallelRunAnalysis: public AnalysisHandler {
0031
0032 public:
0033
0034   /** @name Standard constructors and destructors. */
0035   //@{
0036   /**
0037    * The default constructor.
0038    */
0039   ParallelRunAnalysis();
0040   //@}
0041
0042 public:
0043
0044   /** @name Virtual functions required by the AnalysisHandler class. */
0045   //@{
0046   /**
0047    * Analyze a given Event. Note that a fully generated event
0048    * may be presented several times, if it has been manipulated in
0049    * between. The default version of this function will call transform
0050    * to make a lorentz transformation of the whole event, then extract
0051    * all final state particles and call analyze(tPVector) of this
0052    * analysis object and those of all associated analysis objects. The
0053    * default version will not, however, do anything on events which
0054    * have not been fully generated, or have been manipulated in any
0055    * way.
0056    * @param event pointer to the Event to be analyzed.
0057    * @param ieve the event number.
0058    * @param loop the number of times this event has been presented.
0059    * If negative the event is now fully generated.
0060    * @param state a number different from zero if the event has been
0061    * manipulated in some way since it was last presented.
0062    */
0063   virtual void analyze(tEventPtr event, long ieve, int loop, int state);
0064   //@}
0065
0066 public:
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 protected:
0094
0095   /** @name Standard Interfaced functions. */
0096   //@{
0097   /**
0098    * Initialize this object. Called in the run phase just before
0099    * a run begins.
0100    */
0101   virtual void doinitrun();
0102
0103   /**
0104    * Finalize this object. Called in the run phase just after a
0105    * run has ended. Used eg. to write out statistics.
0106    */
0107   virtual void dofinish();
0108
0109 private:
0110
0111   /**
0112    * The assignment operator is private and must never be called.
0113    * In fact, it should not even be implemented.
0114    */
0115   ParallelRunAnalysis & operator=(const ParallelRunAnalysis &) = delete;
0116
0117 private:
0118
0119 };
0120
0121 }
0122
0123 #endif /* HERWIG_ParallelRunAnalysis_H */