generators/phhepmc/PHGenIntegral.h

0001 // $Id: $
0002
0003 /*!
0004  * \file PHGenIntegral.h
0005  * \brief
0006  * \author Jin Huang <jhuang@bnl.gov>
0007  * \version $Revision:   $
0008  * \date $Date: $
0009  */
0010
0011 #ifndef PHHEPMC_PHGENINTEGRAL_H
0012 #define PHHEPMC_PHGENINTEGRAL_H
0013
0014 #include <phool/PHObject.h>
0015
0016 #include <string>
0017
0018 /*!
0019  * \brief PHGenIntegral
0020  */
0021 class PHGenIntegral : public PHObject
0022 {
0023  public:
0024   PHGenIntegral(){}
0025   ~PHGenIntegral() override{}
0026
0027   //! Integrated luminosity in pb^-1
0028   virtual Double_t get_Integrated_Lumi() const
0029   {
0030     return 0;
0031   }
0032
0033   //! Integrated luminosity in pb^-1
0034   virtual void set_Integrated_Lumi(Double_t /*integratedLumi*/)
0035   {
0036   }
0037
0038   //! Number of accepted events in the event generator. This can be higher than fNProcessedEvent depending on trigger on the event generator
0039   virtual ULong64_t get_N_Generator_Accepted_Event() const
0040   {
0041     return 0;
0042   }
0043
0044   //! Number of accepted events in the event generator. This can be higher than fNProcessedEvent depending on trigger on the event generator
0045   virtual void set_N_Generator_Accepted_Event(ULong64_t /*nGeneratorAcceptedEvent*/)
0046   {
0047   }
0048
0049   //! Number of processed events in the Fun4All cycles
0050   virtual ULong64_t get_N_Processed_Event() const
0051   {
0052     return 0;
0053   }
0054
0055   //! Number of processed events in the Fun4All cycles
0056   virtual void set_N_Processed_Event(ULong64_t /*nProcessedEvent*/)
0057   {
0058   }
0059
0060   //! Sum of weight assigned to the events by the generators.
0061   //! Event weight is normally 1 and thus equal to number of the generated event and is uninteresting.
0062   //! However, there are several cases where one may have nontrivial event weights, e.g. using user hooks in Pythia8 generators to reweight the phase space
0063   virtual Double_t get_Sum_Of_Weight() const
0064   {
0065     return 0;
0066   }
0067
0068   //! Sum of weight assigned to the events by the generators.
0069   //! Event weight is normally 1 and thus equal to number of the generated event and is uninteresting.
0070   //! However, there are several cases where one may have nontrivial event weights, e.g. using user hooks in Pythia8 generators to reweight the phase space
0071   virtual void set_Sum_Of_Weight(Double_t /*sumOfWeight*/)
0072   {
0073   }
0074
0075   //! cross sections for the processed events in pb
0076   virtual Double_t get_CrossSection_Processed_Event() const;
0077
0078   //! cross sections for the events accepted by the event generator in pb
0079   virtual Double_t get_CrossSection_Generator_Accepted_Event() const;
0080
0081   //! description on the source
0082   virtual const std::string& get_Description() const;
0083
0084   //! description on the source
0085   virtual void set_Description(const std::string& /*description*/)
0086   {
0087   }
0088
0089   ClassDefOverride(PHGenIntegral, 1)
0090 };
0091
0092 #endif /* PHHEPMC_PHGENINTEGRAL_H */