herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::DipoleSplittingReweight Class Referenceabstract

DipoleSplittingReweight is used by the dipole shower to reweight splittings from a given dipole splitting kernel. More...

#include <DipoleSplittingReweight.h>

Inheritance diagram for Herwig::DipoleSplittingReweight:

Public Member Functions

Standard constructors and destructors.
 DipoleSplittingReweight ()
 The default constructor.
 
virtual ~DipoleSplittingReweight ()
 The destructor.
 
virtual bool firstInteraction () const
 Return true, if the reweighting should be applied to the first interaction.
 
virtual bool secondaryInteractions () const
 Return true, if the reweighting should be applied to the secondary interactions.
 
void updateCurrentHandler ()
 Update the pointer to the currently active dipole shower handler object.
 
Ptr< DipoleShowerHandler >::tptr currentHandler () const
 Return the pointer to the currently active dipole shower handler object.
 
virtual double evaluate (const DipoleSplittingInfo &) const =0
 Return the reweighting factor for the given splitting type.
 
virtual double hint (const DipoleSplittingInfo &) const
 Return an enhancement hint for the sampling of the un-reweighted splitting kernel.
 
virtual bool hintOnly (const DipoleSplittingInfo &) const
 Return true, if the reweight can be entirely absorbed into the hint.
 
virtual void reweightFactor (const double)
 Set the factor in front of enhance used by the veto algorithm.
 
virtual void negativeScaling (const double)
 Scaling factor for negative reweights.
 
- Public Member Functions inherited from ThePEG::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 StandardModelBaseSM () 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
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
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
 
virtual IBPtr fullclone () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
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
 
virtual IBPtr fullclone () const
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
virtual void debugme () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Functions used by the persistent I/O system.

static AbstractClassDescription< DipoleSplittingReweightinitDipoleSplittingReweight
 The static object used to initialize the description of this class.
 
Ptr< DipoleShowerHandler >::tptr theCurrentHandler
 A pointer to the currently active dipole shower handler object.
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 
DipoleSplittingReweightoperator= (const DipoleSplittingReweight &)=delete
 The assignment operator is private and must never be called.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- 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 ()
 
- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- 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
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 IBPtr clone () const=0
 
 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 &)
 
- Protected Member Functions inherited from ThePEG::Pointer::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)
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

DipoleSplittingReweight is used by the dipole shower to reweight splittings from a given dipole splitting kernel.

Author
Simon Platzer
See also
The interfaces defined for DipoleSplittingReweight.

Definition at line 34 of file DipoleSplittingReweight.h.

Member Function Documentation

◆ evaluate()

virtual double Herwig::DipoleSplittingReweight::evaluate ( const DipoleSplittingInfo ) const
pure virtual

Return the reweighting factor for the given splitting type.

Implemented in Herwig::ColourMatrixElementCorrection.

◆ firstInteraction()

virtual bool Herwig::DipoleSplittingReweight::firstInteraction ( ) const
inlinevirtual

Return true, if the reweighting should be applied to the first interaction.

Definition at line 57 of file DipoleSplittingReweight.h.

◆ hint()

virtual double Herwig::DipoleSplittingReweight::hint ( const DipoleSplittingInfo ) const
inlinevirtual

Return an enhancement hint for the sampling of the un-reweighted splitting kernel.

Reimplemented in Herwig::ColourMatrixElementCorrection.

Definition at line 84 of file DipoleSplittingReweight.h.

◆ hintOnly()

virtual bool Herwig::DipoleSplittingReweight::hintOnly ( const DipoleSplittingInfo ) const
inlinevirtual

Return true, if the reweight can be entirely absorbed into the hint.

A possible detuning will be switched off.

Reimplemented in Herwig::ColourMatrixElementCorrection.

Definition at line 92 of file DipoleSplittingReweight.h.

◆ Init()

static void Herwig::DipoleSplittingReweight::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.

◆ negativeScaling()

virtual void Herwig::DipoleSplittingReweight::negativeScaling ( const double  )
inlinevirtual

Scaling factor for negative reweights.

Reimplemented in Herwig::ColourMatrixElementCorrection.

Definition at line 106 of file DipoleSplittingReweight.h.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::DipoleSplittingReweight::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::DipoleSplittingReweight::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ reweightFactor()

virtual void Herwig::DipoleSplittingReweight::reweightFactor ( const double  )
inlinevirtual

Set the factor in front of enhance used by the veto algorithm.

Reimplemented in Herwig::ColourMatrixElementCorrection.

Definition at line 99 of file DipoleSplittingReweight.h.

◆ secondaryInteractions()

virtual bool Herwig::DipoleSplittingReweight::secondaryInteractions ( ) const
inlinevirtual

Return true, if the reweighting should be applied to the secondary interactions.

Definition at line 63 of file DipoleSplittingReweight.h.

Member Data Documentation

◆ initDipoleSplittingReweight

AbstractClassDescription<DipoleSplittingReweight> Herwig::DipoleSplittingReweight::initDipoleSplittingReweight
staticprivate

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 145 of file DipoleSplittingReweight.h.

◆ theCurrentHandler

Ptr<DipoleShowerHandler>::tptr Herwig::DipoleSplittingReweight::theCurrentHandler
private

A pointer to the currently active dipole shower handler object.

Definition at line 156 of file DipoleSplittingReweight.h.


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