GeneralSampler.h

// -*- C++ -*-
//
// GeneralSampler.h is a part of Herwig - A multi-purpose Monte Carlo event generator
// Copyright (C) 2002-2019 The Herwig Collaboration
//
// Herwig is licenced under version 3 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef Herwig_GeneralSampler_H
#define Herwig_GeneralSampler_H
//
// This is the declaration of the GeneralSampler class.
//
 
#include "ThePEG/Handlers/SamplerBase.h"
#include "BinSampler.h"
 
namespace Herwig {
 
using namespace ThePEG;
 
class GeneralSampler: public SamplerBase {
 
public:
 
  GeneralSampler();
 
  virtual ~GeneralSampler();
 
public:
 
  virtual void initialize();
 
  virtual double generate();
 
  virtual void rejectLast();
 
  virtual int lastBin() const { return lastSampler() ? lastSampler()->bin() : 0; }
 
  virtual CrossSection integratedXSec() const {
    currentCrossSections();
    return theIntegratedXSec;
  }
 
  virtual CrossSection integratedXSecErr() const {
    currentCrossSections();
    return theIntegratedXSecErr;
  }
 
  virtual CrossSection maxXSec() const { 
    if ( theAddUpSamplers )
      return SamplerBase::maxXSec();
    return theMaxWeight*nanobarn;
  }
 
  virtual double sumWeights() const { return theSumWeights; }
 
  virtual double sumWeights2() const { return theSumWeights2; }
 
  virtual double attempts() const { 
    if ( theAddUpSamplers )
      return SamplerBase::attempts();
    return theAttempts;
  }
 
  double accepts() const { return theAccepts; }
 
 
  const map<double,Ptr<BinSampler>::ptr>& samplers() const { return theSamplers; }
 
  Ptr<BinSampler>::ptr binSampler() const { return theBinSampler; }
 
  Ptr<BinSampler>::tptr lastSampler() const { return theLastSampler; }
 
  bool weighted() const { return eventHandler()->weighted(); }
 
  virtual bool almostUnweighted() const { return theAlmostUnweighted; }
 
public:
 
  const XML::Element& grids() const { return theGrids; }
 
  XML::Element& grids() { return theGrids; }
 
  void writeGrids() const;
 
  void readGrids();
  
  unsigned int integrationJobsCreated() {
    return theIntegrationJobsCreated;
  }
 
  virtual void prepare();
 
protected:
 
  map<double,Ptr<BinSampler>::ptr>& samplers() { return theSamplers; }
 
  void lastSampler(Ptr<BinSampler>::tptr s) { theLastSampler = s; }
 
  void currentCrossSections() const;
 
  void updateSamplers();
 
public:
 
  void persistentOutput(PersistentOStream & os) const;
 
  void persistentInput(PersistentIStream & is, int version);
 
  static void Init();
 
protected:
 
  virtual IBPtr clone() const;
 
  virtual IBPtr fullclone() const;
 
 
// If needed, insert declarations of virtual function defined in the
// InterfacedBase class here (using ThePEG-interfaced-decl in Emacs).
 
 
protected:
 
  virtual void doinit();
 
  virtual void doinitrun();
 
  virtual void dofinish();
 
  virtual void rebind(const TranslationMap & trans);
 
  virtual IVector getReferences();
 
private:
 
  bool theVerbose;
 
  XML::Element theGrids;
 
  Ptr<BinSampler>::ptr theBinSampler;
 
  map<double,Ptr<BinSampler>::ptr> theSamplers;
 
  Ptr<BinSampler>::tptr theLastSampler;
 
  mutable CrossSection theIntegratedXSec;
 
  mutable CrossSection theIntegratedXSecErr;
 
  size_t theUpdateAfter;
 
  mutable size_t crossSectionCalls;
 
  mutable bool gotCrossSections;
 
  double theSumWeights;
 
  double theSumWeights2;
 
  double theAttempts;
 
  double theAccepts;
 
  double theMaxWeight;
 
  bool theAddUpSamplers;
 
  bool theGlobalMaximumWeight;
 
  bool theFlatSubprocesses;
 
  bool isSampling;
 
  double theMinSelection;
 
  bool runCombinationData;
 
  bool theAlmostUnweighted;
 
  unsigned long maximumExceeds;
 
  double maximumExceededBy;
 
  double correctWeights;
 
  double theMaxEnhancement;
 
  bool didReadGrids;
 
  bool theParallelIntegration;
 
  unsigned int theIntegratePerJob;
 
  unsigned int theIntegrationJobs;
 
  unsigned int theIntegrationJobsCreated;
  
  bool justAfterIntegrate;
 
  bool theWriteGridsOnFinish;
 
private:
 
  GeneralSampler & operator=(const GeneralSampler &) = delete;
 
};
 
}
 
#endif /* Herwig_GeneralSampler_H */