herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
Herwig::ShowerApproximationKernel Class Reference

ShowerApproximationKernel generates emissions according to a shower approximation entering a NLO matching. More...

#include <ShowerApproximationKernel.h>

Inheritance diagram for Herwig::ShowerApproximationKernel:

Classes

struct  MaxTryException
 Exception to communicate sampler maxtry events. More...
 

Public Member Functions

void setBornXComb (tStdXCombPtr xc)
 Set the XComb object describing the Born process.
 
tcStdXCombPtr bornCXComb () const
 Return the XComb object describing the Born process.
 
tStdXCombPtr bornXComb () const
 Return the XComb object describing the Born process.
 
void setRealXComb (tStdXCombPtr xc)
 Set the XComb object describing the real emission process.
 
tcStdXCombPtr realCXComb () const
 Return the XComb object describing the real emission process.
 
tStdXCombPtr realXComb () const
 Return the XComb object describing the real emission process.
 
void setTildeXCombs (const vector< StdXCombPtr > &xc)
 Set the tilde xcomb objects associated to the real xcomb.
 
const vector< StdXCombPtr > & tildeXCombs () const
 Return the tilde xcomb objects associated to the real xcomb.
 
void setDipole (Ptr< SubtractionDipole >::tptr dip)
 Set the dipole in charge for the emission.
 
Ptr< SubtractionDipole >::tptr dipole () const
 Return the dipole in charge for the emission.
 
void showerApproximation (Ptr< ShowerApproximation >::tptr app)
 Set the shower approximation.
 
Ptr< ShowerApproximation >::tptr showerApproximation () const
 Return the shower approximation.
 
void showerApproximationGenerator (Ptr< ShowerApproximationGenerator >::tptr)
 Set the shower approximation generator.
 
Ptr< ShowerApproximationGenerator >::tptr showerApproximationGenerator () const
 Return the shower approximation generator.
 
double generate ()
 Generate the next emission.
 
void ptCut (Energy pt)
 Set a pt cut on the dipole to generate the radiation.
 
int nDim () const
 Return the number of random numbers needed to sample this kernel.
 
int nDimBorn () const
 Return the number of random numbers needed to sample the Born process.
 
const vector< bool > & sampleFlags ()
 Flag, which variables are free variables.
 
const pair< vector< double >, vector< double > > & support ()
 Return the support of the splitting kernel. More...
 
const vector< double > & parameterPoint ()
 Return the parameter point associated to the splitting previously supplied through fixParameters.
 
void startPresampling ()
 Indicate that presampling of this kernel will be performed in the next calls to evaluate until stopPresampling() is called.
 
void stopPresampling ()
 Indicate that presampling of this kernel is done until startPresampling() is called.
 
void veto (const vector< double > &, double, double)
 Indicate that a veto with the given kernel value and overestimate has occured. More...
 
void accept (const vector< double > &, double, double)
 Indicate that an accept with the given kernel value and overestimate has occured. More...
 
bool presampling () const
 Return true, if currently being presampled.
 
unsigned long presamplingPoints () const
 Return the number of points to presample this splitting generator.
 
unsigned long maxtry () const
 Return the maximum number of trials to generate a splitting.
 
unsigned long freezeGrid () const
 Return the number of accepted points after which the grid should be frozen.
 
void presamplingPoints (unsigned long p)
 Set the number of points to presample this splitting generator.
 
void maxtry (unsigned long p)
 Set the maximum number of trials to generate a splitting.
 
void freezeGrid (unsigned long n)
 Set the number of accepted points after which the grid should be frozen.
 
double evaluate (const vector< double > &)
 Evalute the splitting kernel.
 
int evolutionVariable () const
 Return the index of the random number corresponding to the evolution variable.
 
double evolutionCutoff () const
 Return the cutoff on the evolution random number corresponding to the pt cut.
 
void doCompensate (bool yes=true)
 True, if sampler should apply compensation.
 
Standard constructors and destructors.
 ShowerApproximationKernel ()
 The default constructor.
 
virtual ~ShowerApproximationKernel ()
 The destructor.
 
Wrap to the exsample2 interface until this is finally cleaned up.
const vector< bool > & variable_flags ()
 
size_t evolution_variable () const
 
double evolution_cutoff () const
 
const vector< double > & parameter_point ()
 
void start_presampling ()
 
void stop_presampling ()
 
size_t dimension () const
 
unsigned long presampling_points () const
 
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 HandlerBaseT< UseRandom >
double rnd () const
 
double rnd (double xu) const
 
double rnd (double xl, double xu) const
 
bool rndbool () const
 
bool rndbool (double p) const
 
bool rndbool (double p1, double p2) const
 
int rndsign (double p1, double p2, double p3) const
 
int rnd2 (double p0, double p1) const
 
int rnd3 (double p0, double p1, double p2) const
 
int rnd4 (double p0, double p1, double p2, double p3) const
 
long irnd (long xu=2) const
 
long irnd (long xl, long xu) const
 
const StandardModelBase & SM () const
 
tSMPtr standardModel () const
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual bool defaultInit ()
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
virtual void debugme () const
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::HandlerBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 

Protected Member Functions

Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Private Types

typedef exsample::exponential_generator< ShowerApproximationKernel, UseRandomExponentialGenerator
 Define the Sudakov sampler.
 
typedef exsample::exponential_generator< ShowerApproximationKernel, UseRandom > * ExponentialGeneratorPtr
 Define a pointer to the Sudakov sampler.
 

Private Member Functions

ShowerApproximationKerneloperator= (const ShowerApproximationKernel &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

Ptr< SubtractionDipole >::ptr theDipole
 The dipole in charge of the emission.
 
Ptr< ShowerApproximation >::ptr theShowerApproximation
 The shower approximation to consider.
 
StdXCombPtr theBornXComb
 The XComb off which radiation will be generated.
 
StdXCombPtr theRealXComb
 The XComb describing the process after radiation.
 
vector< StdXCombPtr > theTildeXCombs
 The tilde xcomb objects associated to the real xcomb.
 
bool thePresampling
 True, if currently being presampled.
 
unsigned long thePresamplingPoints
 The number of points to presample this splitting generator.
 
unsigned long theMaxTry
 The maximum number of trials to generate a splitting.
 
unsigned long theFreezeGrid
 Return the number of accepted points after which the grid should be frozen.
 
vector< bool > theFlags
 The sampling flags.
 
pair< vector< double >, vector< double > > theSupport
 The support.
 
Ptr< ShowerApproximationGenerator >::tptr theShowerApproximationGenerator
 The shower approximation generator.
 
vector< double > theLastParameterPoint
 The last parameter point.
 
vector< double > theLastBornPoint
 The last random numbers used for Born sampling.
 
ExponentialGeneratorPtr sampler
 The Sudakov sampler.
 
bool theDoCompensate
 True, if sampler should apply compensation.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

ShowerApproximationKernel generates emissions according to a shower approximation entering a NLO matching.

Author
Simon Platzer

Definition at line 36 of file ShowerApproximationKernel.h.

Member Function Documentation

◆ accept()

void Herwig::ShowerApproximationKernel::accept ( const vector< double > &  ,
double  ,
double   
)
inline

Indicate that an accept with the given kernel value and overestimate has occured.

use born and real xcombs in here to figure out what we need to reweight; it should have its kinematic variables completed at this step

Definition at line 205 of file ShowerApproximationKernel.h.

◆ clone()

virtual IBPtr Herwig::ShowerApproximationKernel::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr Herwig::ShowerApproximationKernel::fullclone ( ) const
protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

◆ Init()

static void Herwig::ShowerApproximationKernel::Init ( )
static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

◆ operator=()

ShowerApproximationKernel& Herwig::ShowerApproximationKernel::operator= ( const ShowerApproximationKernel )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::ShowerApproximationKernel::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

◆ persistentOutput()

void Herwig::ShowerApproximationKernel::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ support()

const pair<vector<double>,vector<double> >& Herwig::ShowerApproximationKernel::support ( )

Return the support of the splitting kernel.

The lower bound on the first variable is assumed to correspond to the cutoff on the evolution variable.

◆ veto()

void Herwig::ShowerApproximationKernel::veto ( const vector< double > &  ,
double  ,
double   
)
inline

Indicate that a veto with the given kernel value and overestimate has occured.

use born and real xcombs in here to figure out what we need to reweight; it should have its kinematic variables completed at this step

Definition at line 197 of file ShowerApproximationKernel.h.


The documentation for this class was generated from the following file: