ThePEG
2.2.1
|
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. More...
#include <SamplerBase.h>
Public Member Functions | |
void | setEventHandler (tStdEHPtr eh) |
Set the event handler for which the function StandardEventHandler::dSigDR(const vector<double> &) function returns the cross section for the chosen phase space point. | |
Standard constructors and destructors. | |
SamplerBase () | |
Constructor. | |
virtual | ~SamplerBase () |
Destructor. | |
Virtual functions to be overridden by sub-classes. | |
virtual void | initialize ()=0 |
Initialize the the sampler, possibly doing presampling of the phase space. | |
virtual void | prepare () |
An external hook to prepare the sampler for generating events, e.g. More... | |
virtual double | generate ()=0 |
Generarate a new phase space point and return a weight associated with it. More... | |
virtual void | rejectLast ()=0 |
Reject the last chosen phase space point. | |
const vector< double > & | lastPoint () const |
Return the last generated phase space point. | |
virtual int | lastBin () const |
If the sampler is able to sample several different functions separately, this function should return the last chosen function. More... | |
virtual CrossSection | integratedXSec () const =0 |
Return the total integrated cross section determined from the Monte Carlo sampling so far. | |
virtual CrossSection | integratedXSecErr () const =0 |
Return the error on the total integrated cross section determined from the Monte Carlo sampling so far. | |
virtual CrossSection | maxXSec () const |
Return the reference cross section, a.k.a. More... | |
virtual double | attempts () const |
Return the number of attempts. More... | |
virtual double | sumWeights () const =0 |
Return the sum of the weights returned by generate() so far (of the events that were not rejeted). | |
virtual double | sumWeights2 () const =0 |
Return the sum of the weights squared returned by generate() so far (of the events that were not rejeted). | |
virtual bool | almostUnweighted () const |
Return true if this sampler is generating almost unweighted events. | |
Functions used by the persistent I/O system. | |
void | persistentOutput (PersistentOStream &os) const |
Function used to write out object persistently. More... | |
void | persistentInput (PersistentIStream &is, int version) |
Function used to read in object persistently. More... | |
Public Member Functions inherited from ThePEG::Interfaced | |
virtual | ~Interfaced () |
Empty virtual destructor. | |
virtual bool | defaultInit () |
Functions which are to be used during the actual event generation, after the setup is complete. More... | |
PPtr | getParticle (PID) const |
Create a new Particle instance given a id number. | |
PDPtr | getParticleData (PID) const |
Return a pointer to the ParticleData object corresponding to the given id number. | |
bool | used () const |
Returns true if this object has actally been used. | |
void | useMe () const |
Should be called to indicate that this object has actually been used. | |
tEGPtr | generator () const |
Return a pointer to the EventGenerator controlling the run. More... | |
void | persistentOutput (PersistentOStream &os) const |
Function used to write out object persistently. More... | |
void | persistentInput (PersistentIStream &is, int version) |
Function used to read in object persistently. More... | |
Public Member Functions inherited from ThePEG::InterfacedBase | |
virtual | ~InterfacedBase () |
The virtual (empty) destructor;. | |
string | fullName () const |
Returns the full name of this object including its path, e.g. More... | |
string | name () const |
Returns the name of this object, without the path. | |
string | path () const |
Returns the path to this object including the trailing '/'. More... | |
string | comment () const |
Returns a comment assigned to this object. | |
void | setup (istream &is) |
Read setup info from a standard istream is. More... | |
virtual IBPtr | fullclone () const |
Return a full clone of this object possibly doing things to the clone to make it sane. | |
virtual void | debugme () const |
Print out debugging information for this object on std::cerr. More... | |
void | update () |
Calls the doupdate() function with recursion prevention. | |
void | init () |
Calls the doinit() function with recursion prevention. | |
virtual bool | preInitialize () const |
Return true if this object needs to be initialized before all other objects (except those for which this function also returns true). More... | |
void | initrun () |
Calls the doinitrun() function with recursion prevention. | |
void | finish () |
Calls the dofinish() function with recursion prevention. | |
void | touch () |
This function should be called every time something in this object has changed in a way that a sanity check with update() is needed. | |
void | reset () |
Set the state of this object to uninitialized. | |
void | clear () |
Calls reset() and unTouch(). | |
InitState | state () const |
Return the state of initialization of this object. | |
bool | locked () const |
Return true if the BaseRepository is not allowed to change the state of this object. | |
bool | touched () const |
Return true if the state of this object has been changed since the last call to update(). | |
void | persistentOutput (PersistentOStream &os) const |
Function used to write out object persistently. More... | |
void | persistentInput (PersistentIStream &is, int version) |
Function used to read in object persistently. More... | |
Public Member Functions inherited from ThePEG::Base | |
virtual | ~Base () |
The virtual destructor. | |
void | debug () const |
Print out debugging information for this object on std::cerr. More... | |
Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted | |
CounterType | referenceCount () const |
Return the reference count. | |
Public Member Functions inherited from ThePEG::Named | |
Named (const string &newName=string()) | |
Constructor with name. | |
Named (const Named &)=default | |
Explicit default copy-constructor (too avoid compiler warnings) | |
const string & | name () const |
Return name. | |
bool | operator== (const Named &other) const |
Test for equality. | |
bool | operator< (const Named &other) const |
Lexicographical comparison. | |
Static Public Member Functions | |
static void | Init () |
Standard Init function used to initialize the interfaces. | |
Static Public Member Functions inherited from ThePEG::Interfaced | |
static void | Init () |
Standard Init function. | |
Static Public Member Functions inherited from ThePEG::InterfacedBase | |
static void | Init () |
Standard Init function. | |
Static Public Member Functions inherited from ThePEG::Base | |
static void | Init () |
The standard Init function used to initialize the interfaces. More... | |
Protected Member Functions | |
vector< double > & | lastPoint () |
Return the last generated phase space point. | |
tStdEHPtr | eventHandler () const |
Return the associated event handler. | |
Protected Member Functions inherited from ThePEG::Interfaced | |
void | reporeg (IBPtr object, string name) const |
Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More... | |
template<typename PtrT > | |
bool | setDefaultReference (PtrT &ptr, string classname, string objectname) |
If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object. | |
Interfaced () | |
Protected default constructor. | |
Interfaced (const string &newName) | |
Protected constructor taking a name as argument. | |
Interfaced (const Interfaced &i) | |
Protected copy-constructor. | |
void | setGenerator (tEGPtr generator) |
Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models. | |
Protected Member Functions inherited from ThePEG::InterfacedBase | |
virtual IBPtr | clone () const =0 |
Return a simple clone of this object. More... | |
InterfacedBase () | |
Protected default constructor. | |
InterfacedBase (string newName) | |
Protected constructor with the name given as argument. | |
InterfacedBase (const InterfacedBase &i) | |
Protected copy-constructor. | |
virtual void | readSetup (istream &is) |
Read setup info from a standard istream is. More... | |
virtual void | doupdate () |
Check sanity of the object during the setup phase. More... | |
virtual void | doinit () |
Initialize this object after the setup phase before saving an EventGenerator to disk. More... | |
virtual void | doinitrun () |
Initialize this object. More... | |
virtual void | dofinish () |
Finalize this object. More... | |
virtual IVector | getReferences () |
Return a vector of all pointers to Interfaced objects used in this object. More... | |
virtual void | rebind (const TranslationMap &) |
Rebind pointer to other Interfaced objects. More... | |
Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted | |
ReferenceCounted () | |
Default constructor. | |
ReferenceCounted (const ReferenceCounted &) | |
Copy-constructor. | |
ReferenceCounted & | operator= (const ReferenceCounted &) |
Assignment. | |
Protected Member Functions inherited from ThePEG::Named | |
const Named & | operator= (const Named &other) |
Assignment. | |
const string & | name (const string &newName) |
Set new name. | |
Private Member Functions | |
SamplerBase & | operator= (const SamplerBase &)=delete |
Private and non-existent assignment operator. | |
Static Private Member Functions | |
static int & | theRunLevel () |
The run level. | |
static bool & | theHasSetupFile () |
True, if a setupfile is in use. | |
static long & | theSeed () |
The seed that has been used for this run to disentangle grids whihch have been adapted further. | |
static unsigned int & | theIntegratePerJob () |
The number of subprocesses to be integrated per job. | |
static unsigned int & | theIntegrationJobs () |
The maximum number of integration jobs to be created. | |
Private Attributes | |
tStdEHPtr | theEventHandler |
The associated event handler. | |
vector< double > | theLastPoint |
The last generated phase space point. | |
string | theIntegrationList |
A file containing a list of subprocesses to integrate. | |
Static Private Attributes | |
static AbstractClassDescription< SamplerBase > | initSamplerBase |
Describe an abstract base class with persistent data. | |
Controlling of run levels and grid handling | |
enum | RunLevels { UnknownMode = 0, InitMode, ReadMode, BuildMode, IntegrationMode, RunMode } |
Enumerate the possible run levels. | |
void | integrationList (const string &newIntegrationList) |
Set a file containing a list of subprocesses to integrate. | |
const string & | integrationList () const |
Return a file containing a list of subprocesses to integrate. | |
static int | runLevel () |
Return the run level. | |
static void | setRunLevel (int level) |
Set the run level. | |
static bool | hasSetupFile () |
Return true, if a setupfile is in use. | |
static void | setupFileUsed (bool yes=true) |
Indicate that a setupfile is in use. | |
static long | seed () |
Return the seed that has been used for this run to disentangle grids whihch have been adapted further. | |
static void | setSeed (long s) |
Set the seed that has been used for this run to disentangle grids whihch have been adapted further. | |
static unsigned int | integratePerJob () |
Return the number of subprocesses to be integrated per job. | |
static void | setIntegratePerJob (unsigned int s) |
Set the number of subprocesses to be integrated per job. | |
static unsigned int | integrationJobs () |
Return the maximum number of integration jobs to be created. | |
static void | setIntegrationJobs (unsigned int s) |
Set the maximum number of integration jobs to be created. | |
Additional Inherited Members | |
Public Types inherited from ThePEG::InterfacedBase | |
enum | InitState { initializing = -1, uninitialized = 0, initialized = 1, runready = 2 } |
Enumeration reflecting the state of an InterfacedBase object. More... | |
Public Types inherited from ThePEG::Pointer::ReferenceCounted | |
typedef unsigned int | CounterType |
The integer type used for counting. | |
Public Attributes inherited from ThePEG::Pointer::ReferenceCounted | |
const unsigned long | uniqueId |
The unique ID. More... | |
Static Protected Member Functions inherited from ThePEG::Interfaced | |
static void | registerRepository (IBPtr) |
Register an Interfaced object with the Repository. | |
static void | registerRepository (IBPtr, string newName) |
Register an Interfaced object with the Repository, giving it a name. | |
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().
Definition at line 35 of file SamplerBase.h.
|
inlinevirtual |
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.
Definition at line 132 of file SamplerBase.h.
References integratedXSec(), integratedXSecErr(), ThePEG::sqr(), sumWeights(), and sumWeights2().
Referenced by maxXSec().
|
pure virtual |
Generarate a new phase space point and return a weight associated with it.
This weight should preferably be 1.
Implemented in ThePEG::ACDCSampler.
Referenced by prepare().
|
inlinevirtual |
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.
Reimplemented in ThePEG::ACDCSampler.
Definition at line 99 of file SamplerBase.h.
References integratedXSec(), and integratedXSecErr().
|
inlinevirtual |
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.
Definition at line 120 of file SamplerBase.h.
References attempts(), integratedXSec(), sumWeights(), sumWeights2(), and ThePEG::ZERO.
void ThePEG::SamplerBase::persistentInput | ( | PersistentIStream & | is, |
int | version | ||
) |
Function used to read in object persistently.
is | the persistent input stream read from. |
version | the version number of the object when written. |
Referenced by eventHandler().
void ThePEG::SamplerBase::persistentOutput | ( | PersistentOStream & | os | ) | const |
Function used to write out object persistently.
os | the persistent output stream written to. |
Referenced by eventHandler().
|
inlinevirtual |
An external hook to prepare the sampler for generating events, e.g.
by combining grid files from parallel integration runs.
Definition at line 76 of file SamplerBase.h.
References generate(), and rejectLast().