Page MenuHomeHEPForge
Files F8308651

No OneTemporary
Actions

View Options

diff --git a/Handlers/SamplerBase.h b/Handlers/SamplerBase.h
--- a/Handlers/SamplerBase.h
+++ b/Handlers/SamplerBase.h
@@ -1,397 +1,419 @@
// -*- C++ -*-
//
// SamplerBase.h is a part of ThePEG - Toolkit for HEP Event Generation
// Copyright (C) 1999-2011 Leif Lonnblad
//
// ThePEG is licenced under version 2 of the GPL, see COPYING for details.
// Please respect the MCnet academic guidelines, see GUIDELINES for details.
//
#ifndef ThePEG_SamplerBase_H
#define ThePEG_SamplerBase_H
// This is the declaration of the SamplerBase class.
#include "ThePEG/Interface/Interfaced.h"
#include "SamplerBase.fh"
#include "ThePEG/Handlers/StandardEventHandler.fh"
// #include "SamplerBase.xh"
namespace ThePEG {
/**
* This is the base class for all phase space sampler classes to be
* used by the EventHandler class to sample the phase space according
* to the cross sections for the processes in the EventHandler. The
* class should be able to sample a unit hyper-cube in arbitrary
* dimensions. The points need not necessarily be sampled with unit
* weight.
*
* The virtual methods to be implemented by concrete sub-classes are
* initialize(), generate() and rejectLast().
*
* @see \ref SamplerBaseInterfaces "The interfaces"
* defined for SamplerBase.
* @see EventHandler
*/
class SamplerBase: public Interfaced {
public:
/** @name Standard constructors and destructors. */
//@{
/**
* Constructor
*/
SamplerBase()
: Interfaced(),
theIntegrationList(""),
theGridDirectory(".") {}
/**
* Destructor.
*/
virtual ~SamplerBase();
//@}
public:
/**
* Set the event handler for which the function
* StandardEventHandler::dSigDR(const vector<double> &) function
* returns the cross section for the chosen phase space point.
*/
void setEventHandler(tStdEHPtr eh) { theEventHandler = eh; }
/** @name Virtual functions to be overridden by sub-classes. */
//@{
/**
* Initialize the the sampler, possibly doing presampling of the
* phase space.
*/
virtual void initialize() = 0;
/**
* Generarate a new phase space point and return a weight associated
* with it. This weight should preferably be 1.
*/
virtual double generate() = 0;
/**
* Reject the last chosen phase space point.
*/
virtual void rejectLast() = 0;
/**
* Return the last generated phase space point.
*/
const vector<double> & lastPoint() const { return theLastPoint; }
/**
* If the sampler is able to sample several different functions
* separately, this function should return the last chosen
* function. This default version always returns 0.
*/
virtual int lastBin() const { return 0; }
/**
* Return the total integrated cross section determined from the
* Monte Carlo sampling so far.
*/
virtual CrossSection integratedXSec() const = 0;
/**
* Return the error on the total integrated cross section determined
* from the Monte Carlo sampling so far.
*/
virtual CrossSection integratedXSecErr() const = 0;
/**
* Return the reference cross section, a.k.a. maximum weight. When
* not provided directly, this will be determined effectively from
* the sum of weights and sum of weights squared to match up the
* standard definition of a Monte Carlo cross section along with the
* cross section and error quoted.
*/
virtual CrossSection maxXSec() const {
if ( sumWeights2() <= 0.0 ) return ZERO;
return integratedXSec()*attempts()/sumWeights();
}
/**
* Return the number of attempts. When not provided directly, this
* will be determined effectively from the sum of weights and sum of
* weights squared to match up the standard definition of a Monte
* Carlo cross section along with the cross section and error
* quoted.
*/
virtual double attempts() const {
CrossSection sigma = integratedXSec();
CrossSection esigma = integratedXSecErr();
double sw = sumWeights(); double sw2 = sumWeights2();
if ( sw2 <= 0.0 ) return 0.0;
return
sqr(sw)*(sqr(esigma)-sqr(sigma))/(sqr(sw)*sqr(esigma) - sw2*sqr(sigma));
}
/**
* Return the sum of the weights returned by generate() so far (of
* the events that were not rejeted).
*/
virtual double sumWeights() const = 0;
/**
* Return the sum of the weights squared returned by generate() so
* far (of the events that were not rejeted).
*/
virtual double sumWeights2() const = 0;
//@}
/** @name Controlling of run levels and grid handling*/
//@{
/**
* Set a file containing a list of subprocesses to integrate
*/
void integrationList(const string& newIntegrationList) { theIntegrationList = newIntegrationList; }
/**
* Return a file containing a list of subprocesses to integrate
*/
const string& integrationList() const { return theIntegrationList; }
/**
* Set the directory to be used to store grid information
*/
void gridDirectory(const string& d) { theGridDirectory = d; }
/**
* Return the directory to be used to store grid information
*/
const string& gridDirectory() const { return theGridDirectory; }
/**
* Set the directory to be used to store parallel integration information
*/
void parallelIntegrationDirectory(const string& d) { theParallelIntegrationDirectory = d; }
/**
* Return the directory to be used to store parallel integration grid information
*/
const string& parallelIntegrationDirectory() const { return theParallelIntegrationDirectory; }
/**
* Enumerate the possible run levels
*/
enum RunLevels {
UnknownMode = 0,
InitMode,
ReadMode,
BuildMode,
IntegrationMode,
RunMode
};
/**
* Return the run level
*/
static int runLevel() {
return theRunLevel();
}
/**
* Set the run level
*/
static void setRunLevel(int level) {
theRunLevel() = level;
}
/**
* Return true, if a setupfile is in use
*/
static bool hasSetupFile() {
return theHasSetupFile();
}
/**
* Indicate that a setupfile is in use.
*/
static void setupFileUsed(bool yes = true) {
theHasSetupFile() = yes;
}
/**
* Return the seed that has been used for this run to disentangle
* grids whihch have been adapted further
*/
static long seed() {
return theSeed();
}
/**
* Set the seed that has been used for this run to disentangle
* grids whihch have been adapted further
*/
static void setSeed(long s) {
theSeed() = s;
}
/**
* Return the number of subprocesses to be integrated per job.
*/
static unsigned int integratePerJob() {
return theIntegratePerJob();
}
/**
* Set the number of subprocesses to be integrated per job.
*/
static void setIntegratePerJob(unsigned int s) {
theIntegratePerJob() = s;
}
+ /**
+ * Return the maximum number of integration jobs to be created.
+ */
+ static unsigned int integrationJobs() {
+ return theIntegrationJobs();
+ }
+
+ /**
+ * Set the maximum number of integration jobs to be created.
+ */
+ static void setIntegrationJobs(unsigned int s) {
+ theIntegrationJobs() = s;
+ }
+
//@}
protected:
/**
* Return the last generated phase space point.
*/
vector<double> & lastPoint() { return theLastPoint; }
/**
* Return the associated event handler.
*/
tStdEHPtr eventHandler() const { return theEventHandler; }
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 interfaces.
*/
static void Init();
private:
/**
* The associated event handler.
*/
tStdEHPtr theEventHandler;
/**
* The last generated phase space point.
*/
vector<double> theLastPoint;
/**
* A file containing a list of subprocesses to integrate
*/
string theIntegrationList;
/**
* The directory to be used to store grid information
*/
string theGridDirectory;
/**
* The directory to be used to store parallel integration information
*/
string theParallelIntegrationDirectory;
/**
* The run level
*/
static int& theRunLevel() {
static int lvl = UnknownMode;
return lvl;
}
/**
* True, if a setupfile is in use
*/
static bool& theHasSetupFile() {
static bool flag = false;
return flag;
}
/**
* The seed that has been used for this run to disentangle
* grids whihch have been adapted further
*/
static long& theSeed() {
static long s = 0;
return s;
}
/**
* The number of subprocesses to be integrated per job.
*/
static unsigned int& theIntegratePerJob() {
static unsigned int s = 0;
return s;
}
+ /**
+ * The maximum number of integration jobs to be created.
+ */
+ static unsigned int& theIntegrationJobs() {
+ static unsigned int s = 0;
+ return s;
+ }
+
private:
/**
* Describe an abstract base class with persistent data.
*/
static AbstractClassDescription<SamplerBase> initSamplerBase;
/**
* Private and non-existent assignment operator.
*/
SamplerBase & operator=(const SamplerBase &);
};
}
namespace ThePEG {
/** @cond TRAITSPECIALIZATIONS */
/**
* This template specialization informs ThePEG about the base class of
* SamplerBase.
*/
template <>
struct BaseClassTrait<SamplerBase,1>: public ClassTraitsType {
/** Typedef of the base class of SamplerBase. */
typedef Interfaced NthBase;
};
/**
* This template specialization informs ThePEG about the name of the
* SamplerBase class.
*/
template <>
struct ClassTraits<SamplerBase>: public ClassTraitsBase<SamplerBase> {
/** Return the class name. */
static string className() { return "ThePEG::SamplerBase"; }
};
/** @endcond */
}
#endif /* ThePEG_SamplerBase_H */

File Metadata

Mime Type
text/x-diff
Expires
Sat, Dec 21, 12:45 PM (1 d, 17 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
4022816
Default Alt Text
(10 KB)

Event Timeline