herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::QTildeShowerHandler Class Reference

The QTildeShowerHandler class. More...

#include <QTildeShowerHandler.h>

Inheritance diagram for Herwig::QTildeShowerHandler:

Public Types

typedef Ptr< XComb >::pointer XCPtr
 Pointer to an XComb object.
 
- Public Types inherited from Herwig::ShowerHandler
typedef pair< tRemPPtr, tRemPPtr > RemPair
 Typedef for a pair of ThePEG::RemnantParticle pointers.
 
typedef multiset< tcPDPtr, ParticleOrderingOrderedParticles
 A container for ordered particles required for constructing tags for decay mode lookup.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Public Types inherited from ThePEG::LastXCombInfo< typename XC >
typedef ThePEG::Ptr< XC >::pointer XCPtr
 
typedef ThePEG::Ptr< XC >::const_pointer cXCPtr
 
typedef ThePEG::Ptr< XC >::transient_pointer tXCPtr
 
typedef ThePEG::Ptr< XC >::transient_const_pointer tcXCPtr
 

Public Member Functions

 QTildeShowerHandler ()
 The default constructor.
 
void fillEventRecord ()
 At the end of the Showering, transform ShowerParticle objects into ThePEG particles and fill the event record with them.
 
virtual Energy hardScale () const
 Return the relevant hard scale to be used in the profile scales.
 
virtual bool showerHardProcessVeto () const
 Hook to allow vetoing of event after showering hard sub-process as in e.g.
 
virtual HardTreePtr generateCKKW (ShowerTreePtr tree) const
 Generate hard emissions for CKKW etc.
 
virtual void showerHardProcess (ShowerTreePtr, XCPtr)
 Members to perform the shower.
 
virtual void showerDecay (ShowerTreePtr)
 Perform the shower of a decay.
 
tSplittingGeneratorPtr splittingGenerator () const
 Access to the flags and shower variables.
 
int hardEmission () const
 Mode for hard emissions.
 
virtual void connectTrees (ShowerTreePtr showerTree, HardTreePtr hardTree, bool hard)
 Connect the Hard and Shower trees.
 
unsigned int softCorrelations () const
 Access to switches for spin correlations.
 
virtual bool correlations () const
 Any correlations.
 
tKinematicsReconstructorPtr kinematicsReconstructor () const
 Access methods to access the objects.
 
tPartnerFinderPtr partnerFinder () const
 Access to the PartnerFinder object.
 
- Public Member Functions inherited from Herwig::ShowerHandler
 ShowerHandler ()
 Default constructor.
 
virtual ~ShowerHandler ()
 Destructor.
 
virtual void cascade ()
 The main method which manages the multiple interactions and starts the shower by calling cascade(sub, lastXC).
 
virtual bool showerHardProcessVeto () const
 Hook to allow vetoing of event after showering hard sub-process as in e.g.
 
virtual bool isReshuffling () const
 Return true, if this cascade handler will perform reshuffling from hard process masses.
 
virtual bool retConstituentMasses () const
 Return true, if this cascade handler will put the final state particles to their constituent mass.
 
virtual bool canHandleMatchboxTrunc () const
 Return true, if the shower handler can generate a truncated shower for POWHEG style events generated using Matchbox.
 
Energy pdfFreezingScale () const
 Get the PDF freezing scale.
 
PDFPtr getPDFA () const
 Get the local PDFs.
 
PDFPtr getPDFB () const
 Get the local PDFs.
 
bool firstInteraction () const
 Return true if currently the primary subprocess is showered.
 
tHwRemDecPtr remnantDecayer () const
 Return the remnant decayer.
 
void splitHardProcess (tPVector tagged, PerturbativeProcessPtr &hard, DecayProcessMap &decay) const
 Split the hard process into production and decays.
 
bool doesSplitHardProcess () const
 Information if the Showerhandler splits the hard process.
 
tDMPtr decay (PerturbativeProcessPtr, DecayProcessMap &decay, bool radPhotons=false) const
 Decay a particle.
 
tDMPtr findDecayMode (const string &tag) const
 Cached lookup of decay modes.
 
bool doRadiation () const
 Switch for any radiation.
 
bool doFSR () const
 Switch on or off final state radiation.
 
bool doISR () const
 Switch on or off initial state radiation.
 
bool hardScaleIsMuF () const
 Return true if maximum pt should be deduced from the factorization scale.
 
double factorizationScaleFactor () const
 The factorization scale factor.
 
double renFac () const
 The renormalization scale factor.
 
double facFac () const
 The factorization scale factor.
 
double renormalizationScaleFactor () const
 The renormalization scale factor.
 
double hardScaleFactor () const
 The scale factor for the hard scale.
 
bool restrictPhasespace () const
 Return true, if the phase space restrictions of the dipole shower should be applied.
 
Ptr< HardScaleProfile >::tptr profileScales () const
 Return profile scales.
 
virtual int showerPhaseSpaceOption () const
 Return information about shower phase space choices.
 
map< string, ShowerVariation > & showerVariations ()
 Access the shower variations.
 
const map< string, ShowerVariation > & showerVariations () const
 Return the shower variations.
 
map< string, double > & currentWeights ()
 Access the current Weights.
 
const map< string, double > & currentWeights () const
 Return the current Weights.
 
void reweight (double w)
 Change the current reweighting factor.
 
double reweight () const
 Return the current reweighting factor.
 
unsigned int spinCorrelations () const
 Access to switches for spin correlations.
 
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.
 
bool decaysInShower (long id) const
 Check if a particle decays in the shower.
 
- Public Member Functions inherited from ThePEG::CascadeHandler
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
 
virtual void cascade ()=0
 
virtual double reweightCKKW (int minMult, int maxMult)
 
const tPVectortagged () const
 
const Hinthint () const
 
const PDFfirstPDF () const
 
const PDFsecondPDF () const
 
const pair< PDF, PDF > & pdfs () const
 
void resetPDFs (const pair< tcPDFPtr, tcPDFPtr > &pdfpair)
 
void resetPDFs (const pair< tcPDFPtr, tcPDFPtr > &pdfpair, PBPair ppair)
 
void setXComb (tXCombPtr xc)
 
virtual bool isReshuffling () const
 
bool didRunCascade () const
 
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
 
virtual void cascade ()=0
 
virtual double reweightCKKW (int minMult, int maxMult)
 
- Public Member Functions inherited from ThePEG::StepHandler
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)=0
 
tEHPtr eventHandler () const
 
void eventHandler (tEHPtr)
 
tStepPtr newStep ()
 
tStepPtr currentStep ()
 
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)=0
 
- 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
 
- Public Member Functions inherited from ThePEG::LastXCombInfo< typename XC >
const XC & lastXComb () const
 
tXCPtr lastXCombPtr () const
 
const XC & lastHeadXComb () const
 
tXCPtr lastHeadXCombPtr () const
 
const EventHandlerlastEventHandler () const
 
tPExtrPtr lastExtractor () const
 
PDFT pdf (tcPPtr parton) const
 
const CutslastCuts () const
 
tCutsPtr lastCutsPtr () const
 
const PPairlastParticles () const
 
Energy2 lastS () const
 
const PPairlastPartons () const
 
Energy2 lastSHat () const
 
double lastTau () const
 
double lastY () const
 
double lastP1 () const
 
double lastP2 () const
 
double lastL1 () const
 
double lastL2 () const
 
double lastX1 () const
 
double lastX2 () const
 
double lastE1 () const
 
double lastE2 () const
 
double lastFL1L2 () const
 
Energy2 lastScale () const
 
double lastAlphaS () const
 
double lastAlphaEM () const
 
const vector< Lorentz5Momentum > & meMomenta () const
 
double lastME2 () const
 
double lastPreweight () const
 
double jacobian () const
 
CrossSection lastMECrossSection () const
 
double lastMEPDFWeight () const
 
double lastMECouplings () const
 
tSubProPtr subProcess () const
 
const cPDVectormePartonData () const
 
const XC & lastXComb () const
 
tXCPtr lastXCombPtr () const
 
const XC & lastHeadXComb () const
 
tXCPtr lastHeadXCombPtr () const
 
const EventHandlerlastEventHandler () const
 
tPExtrPtr lastExtractor () const
 
PDFT pdf (tcPPtr parton) const
 
const CutslastCuts () const
 
tCutsPtr lastCutsPtr () const
 
const PPairlastParticles () const
 
Energy2 lastS () const
 
const PPairlastPartons () const
 
Energy2 lastSHat () const
 
double lastTau () const
 
double lastY () const
 
double lastP1 () const
 
double lastP2 () const
 
double lastL1 () const
 
double lastL2 () const
 
double lastX1 () const
 
double lastX2 () const
 
double lastE1 () const
 
double lastE2 () const
 
double lastFL1L2 () const
 

Protected Member Functions

void doShowering (bool hard, XCPtr)
 Perform the shower.
 
virtual RealEmissionProcessPtr hardMatrixElementCorrection (bool)
 Generate the hard matrix element correction.
 
virtual void hardestEmission (bool hard)
 Generate the hardest emission.
 
void setupMECorrection (RealEmissionProcessPtr real)
 Set up for applying a matrix element correction.
 
virtual vector< ShowerProgenitorPtr > setupShower (bool hard)
 Extract the particles to be showered, set the evolution scales and apply the hard matrix element correction.
 
virtual void setEvolutionPartners (bool hard, ShowerInteraction, bool clear)
 set the colour partners
 
virtual bool timeLikeShower (tShowerParticlePtr particle, ShowerInteraction, Branching fb, bool first)
 Methods to perform the evolution of an individual particle, including recursive calling on the products.
 
virtual bool spaceLikeShower (tShowerParticlePtr particle, PPtr beam, ShowerInteraction)
 It does the backward evolution of the space-like input particle (and recursively for all its time-like radiation products).
 
virtual bool spaceLikeDecayShower (tShowerParticlePtr particle, const ShowerParticle::EvolutionScales &maxScales, Energy minimumMass, ShowerInteraction, Branching fb)
 If does the forward evolution of the input on-shell particle involved in a decay (and recursively for all its time-like radiation products).
 
virtual bool truncatedTimeLikeShower (tShowerParticlePtr particle, HardBranchingPtr branch, ShowerInteraction type, Branching fb, bool first)
 Truncated shower from a time-like particle.
 
virtual bool truncatedSpaceLikeShower (tShowerParticlePtr particle, PPtr beam, HardBranchingPtr branch, ShowerInteraction type)
 Truncated shower from a space-like particle.
 
virtual bool truncatedSpaceLikeDecayShower (tShowerParticlePtr particle, const ShowerParticle::EvolutionScales &maxScales, Energy minimumMass, HardBranchingPtr branch, ShowerInteraction type, Branching fb)
 Truncated shower from a time-like particle.
 
bool MECOn () const
 Switches for matrix element corrections.
 
bool hardMEC () const
 Any hard ME correction?
 
bool softMEC () const
 Any soft ME correction?
 
bool isTruncatedShowerON () const
 Is the truncated shower on?
 
bool ipTon () const
 Switch for intrinsic pT.
 
Additional shower vetoes
void addVeto (ShowerVetoPtr v)
 Insert a veto.
 
void removeVeto (ShowerVetoPtr v)
 Remove a veto.
 
bool hardVetoReadOption () const
 Switches for vetoing hard emissions.
 
double initialStateRadiationEnhancementFactor () const
 Enhancement factors for radiation needed to generate the soft matrix element correction.
 
double finalStateRadiationEnhancementFactor () const
 Access the enhancement factor for final-state radiation.
 
void initialStateRadiationEnhancementFactor (double in)
 Set the enhancement factor for initial-state radiation.
 
void finalStateRadiationEnhancementFactor (double in)
 Set the enhancement factor for final-state radiation.
 
tHardTreePtr hardTree ()
 Access to set/get the HardTree currently beinging showered.
 
void hardTree (tHardTreePtr in)
 The HardTree currently being showered.
 
Ptr< BeamParticleData >::const_pointer beamParticle () const
 Access/set the beam particle for the current initial-state shower.
 
void setBeamParticle (Ptr< BeamParticleData >::const_pointer in)
 Set the beam particle data.
 
tShowerTreePtr currentTree ()
 Set/Get the current tree being evolver for inheriting classes.
 
void currentTree (tShowerTreePtr tree)
 Set the tree.
 
unsigned int maximumTries () const
 Access the maximum number of attempts to generate the shower.
 
ShowerProgenitorPtr progenitor ()
 Set/Get the ShowerProgenitor for the current shower.
 
void progenitor (ShowerProgenitorPtr in)
 Set the progenitor.
 
virtual void generateIntrinsicpT (vector< ShowerProgenitorPtr >)
 Calculate the intrinsic \(p_T\).
 
map< tShowerProgenitorPtr, pair< Energy, double > > & intrinsicpT ()
 Access to the intrinsic \(p_T\) for inheriting classes.
 
void setupMaximumScales (const vector< ShowerProgenitorPtr > &, XCPtr)
 find the maximally allowed pt acc to the hard process.
 
void setupHardScales (const vector< ShowerProgenitorPtr > &, XCPtr)
 find the relevant hard scales for profile scales.
 
void convertHardTree (bool hard, ShowerInteraction type)
 Convert the HardTree into an extra shower emission.
 
PPtr findFirstParton (tPPtr seed) const
 Find the parton extracted from the incoming particle after ISR.
 
tPPair remakeRemnant (tPPair oldp)
 Fix Remnant connections after ISR.
 
virtual bool startTimeLikeShower (ShowerInteraction)
 Start the shower of a timelike particle.
 
void updateHistory (tShowerParticlePtr particle)
 Update of the time-like stuff.
 
virtual bool startSpaceLikeShower (PPtr, ShowerInteraction)
 Start the shower of a spacelike particle.
 
virtual bool startSpaceLikeDecayShower (const ShowerParticle::EvolutionScales &maxScales, Energy minimumMass, ShowerInteraction)
 Start the shower of a spacelike particle.
 
Branching selectTimeLikeBranching (tShowerParticlePtr particle, ShowerInteraction type, HardBranchingPtr branch)
 Select the branching for the next time-like emission.
 
Branching selectSpaceLikeDecayBranching (tShowerParticlePtr particle, const ShowerParticle::EvolutionScales &maxScales, Energy minmass, ShowerInteraction type, HardBranchingPtr branch)
 Select the branching for the next space-like emission in a decay.
 
ShowerParticleVector createTimeLikeChildren (tShowerParticlePtr particle, IdList ids)
 Create the timelike child of a branching.
 
virtual bool timeLikeVetoed (const Branching &, ShowerParticlePtr)
 Vetos for the timelike shower.
 
virtual bool spaceLikeVetoed (const Branching &, ShowerParticlePtr)
 Vetos for the spacelike shower.
 
virtual bool spaceLikeDecayVetoed (const Branching &, ShowerParticlePtr)
 Vetos for the spacelike shower.
 
bool hardOnly () const
 Only generate the hard emission, for testing only.
 
void checkFlags ()
 Check the flags.
 
void addFSRUsingDecayPOWHEG (HardTreePtr ISRTree)
 
- Protected Member Functions inherited from Herwig::ShowerHandler
virtual tPPair cascade (tSubProPtr sub, XCPtr xcomb)
 The main method which manages the showering of a subprocess.
 
void prepareCascade (tSubProPtr sub)
 Set up for the cascade.
 
void boostCollision (bool boost)
 Boost all the particles in the collision so that the collision always occurs in the rest frame with the incoming particles along the z axis.
 
void setCurrentHandler ()
 Set/unset the current shower handler.
 
void unSetCurrentHandler ()
 Unset the current handler.
 
tSubProPtr currentSubProcess () const
 Return the currently used SubProcess.
 
tPPair incomingBeams () const
 Access to the incoming beam particles.
 
void combineWeights ()
 Weight handling for shower variations.
 
void initializeWeights ()
 Initialise the weights in currentEvent()
 
void resetWeights ()
 Reset the current weights.
 
unsigned int maxtry () const
 Return the maximum number of attempts for showering a given subprocess.
 
bool includeSpaceTime () const
 Parameters for the space-time model.
 
Energy2 vMin () const
 The minimum virtuality for the space-time model.
 
virtual void dofinish ()
 Finalize this object.
 
bool isMPIOn () const
 Return true if multiple parton interactions are switched on and can be used for this beam setup.
 
tUEBasePtr getMPIHandler () const
 Access function for the MPIHandler, it should only be called after checking with isMPIOn.
 
bool isResolvedHadron (tPPtr)
 Is a beam particle where hadronic structure is resolved.
 
RemPair getRemnants (PBIPair incbins)
 Get the remnants from the ThePEG::PartonBinInstance es and do some checks.
 
void setMPIPDFs ()
 Reset the PDF's after the hard collision has been showered.
 
void findDecayProducts (PPtr parent, PerturbativeProcessPtr hard, DecayProcessMap &decay) const
 Members to handle splitting up of hard process and decays.
 
void createDecayProcess (PPtr parent, PerturbativeProcessPtr hard, DecayProcessMap &decay) const
 Find decay products from the hard process and create decay processes.
 
- Protected Member Functions inherited from ThePEG::StepHandler
void createNewStep ()
 
- 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)
 

Clone Methods.

ShowerTreePtr hard_
 Stuff from the ShowerHandler.
 
ShowerDecayMap decay_
 The ShowerTree for the decays.
 
vector< ShowerTreePtr > done_
 The ShowerTrees for which the initial shower.
 
SplittingGeneratorPtr _splittingGenerator
 Pointer to the splitting generator.
 
unsigned int _maxtry
 Maximum number of tries to generate the shower of a particular tree.
 
unsigned int _meCorrMode
 Matrix element correction switch.
 
unsigned int _evolutionScheme
 Control of the reconstruction option.
 
bool _hardVetoReadOption
 If hard veto pT scale is being read-in this determines whether the read-in value is applied to primary and secondary (MPI) scatters or just the primary one, with the usual computation of the veto being performed for the secondary (MPI) scatters.
 
Energy _iptrms
 rms intrinsic pT of Gaussian distribution
 
double _beta
 Proportion of inverse quadratic intrinsic pT distribution.
 
Energy _gamma
 Parameter for inverse quadratic: 2*Beta*Gamma/(sqr(Gamma)+sqr(intrinsicpT))
 
Energy _iptmax
 Upper bound on intrinsic pT for inverse quadratic.
 
unsigned int _limitEmissions
 Limit the number of emissions for testing.
 
ShowerProgenitorPtr _progenitor
 The progenitor of the current shower.
 
HwMEBasePtr _hardme
 Matrix element.
 
HwDecayerBasePtr _decayme
 Decayer.
 
ShowerTreePtr _currenttree
 The ShowerTree currently being showered.
 
HardTreePtr _hardtree
 The HardTree currently being showered.
 
double _initialenhance
 Radiation enhancement factors for use with the veto algorithm if needed by the soft matrix element correction.
 
double _finalenhance
 Enhancement factor for final-state radiation.
 
Ptr< BeamParticleData >::const_pointer _beam
 The beam particle data for the current initial-state shower.
 
map< tShowerProgenitorPtr, pair< Energy, double > > _intrinsic
 Storage of the intrinsic \(p_t\) of the particles.
 
vector< ShowerVetoPtr > _vetoes
 Vetoes.
 
vector< FullShowerVetoPtr > _fullShowerVetoes
 Full Shower Vetoes.
 
unsigned int _nReWeight
 Number of iterations for reweighting.
 
bool _reWeight
 Whether or not we are reweighting.
 
unsigned int _nis
 number of IS emissions
 
unsigned int _nfs
 Number of FS emissions.
 
ShowerInteraction interaction_
 The option for wqhich interactions to use.
 
bool _trunc_Mode
 Truncated shower switch.
 
int _hardEmission
 Mode for the hard emissions.
 
unsigned int _softOpt
 Option for the kernal for soft correlations.
 
bool _hardPOWHEG
 Option for hard radiation in POWHEG events.
 
Energy muPt
 The relevant hard scale to be used in the profile scales.
 
KinematicsReconstructorPtr _reconstructor
 Pointer to the various objects.
 
PartnerFinderPtr _partnerfinder
 Pointer to the PartnerFinder object.
 
static bool _hardEmissionWarn
 True if no warnings about incorrect hard emission mode setting have been issued yet.
 
static bool _missingTruncWarn
 True if no warnings about missing truncated shower have been issued yet.
 
virtual IBPtr clone () const
 Make a simple clone of this object.
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
 
virtual void doinitrun ()
 Initialize this object.
 
QTildeShowerHandleroperator= (const QTildeShowerHandler &)=delete
 The assignment operator is private and must never be called.
 

Functions used by the persistent I/O system.

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.
 
virtual tPPair cascade (tSubProPtr sub, XCPtr xcomb)
 The main method which manages the showering of a subprocess.
 
void decay (ShowerTreePtr tree, ShowerDecayMap &decay)
 Decay a ShowerTree.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 

Additional Inherited Members

- Static Public Member Functions inherited from Herwig::ShowerHandler
static const tShowerHandlerPtr currentHandler ()
 pointer to "this", the current ShowerHandler.
 
static bool currentHandlerIsSet ()
 pointer to "this", the current ShowerHandler.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- Static Public Member Functions inherited from ThePEG::CascadeHandler
static void setDidRunCascade (bool c)
 
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::StepHandler
static void Init ()
 
- 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
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 
- Protected Attributes inherited from ThePEG::LastXCombInfo< typename XC >
XCPtr theLastXComb
 

Detailed Description

The QTildeShowerHandler class.

See also
The interfaces defined for QTildeShowerHandler.

Definition at line 36 of file QTildeShowerHandler.h.

Member Typedef Documentation

◆ XCPtr

Pointer to an XComb object.

Definition at line 43 of file QTildeShowerHandler.h.

Member Function Documentation

◆ addVeto()

void Herwig::QTildeShowerHandler::addVeto ( ShowerVetoPtr  v)
inlineprotected

Insert a veto.

Definition at line 303 of file QTildeShowerHandler.h.

References _vetoes, and v.

◆ beamParticle()

Ptr< BeamParticleData >::const_pointer Herwig::QTildeShowerHandler::beamParticle ( ) const
inlineprotected

Access/set the beam particle for the current initial-state shower.

Get the beam particle data

Definition at line 375 of file QTildeShowerHandler.h.

References _beam.

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from Herwig::ShowerHandler.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, and Herwig::PowhegShowerHandler.

◆ correlations()

virtual bool Herwig::QTildeShowerHandler::correlations ( ) const
inlinevirtual

Any correlations.

Reimplemented from Herwig::ShowerHandler.

Definition at line 131 of file QTildeShowerHandler.h.

References _softOpt, and Herwig::ShowerHandler::spinCorrelations().

◆ currentTree() [1/2]

tShowerTreePtr Herwig::QTildeShowerHandler::currentTree ( )
inlineprotected

Set/Get the current tree being evolver for inheriting classes.

Get the tree

Definition at line 390 of file QTildeShowerHandler.h.

References _currenttree.

◆ currentTree() [2/2]

void Herwig::QTildeShowerHandler::currentTree ( tShowerTreePtr  tree)
inlineprotected

Set the tree.

Definition at line 395 of file QTildeShowerHandler.h.

References _currenttree.

◆ doinit()

virtual void Herwig::QTildeShowerHandler::doinit ( )
protectedvirtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Exceptions
InitExceptionif object could not be initialized properly.

Reimplemented from Herwig::ShowerHandler.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, and Herwig::PowhegShowerHandler.

◆ doinitrun()

virtual void Herwig::QTildeShowerHandler::doinitrun ( )
protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from Herwig::ShowerHandler.

Reimplemented in Herwig::AlpGenHandlerOL, and Herwig::FxFxHandler.

◆ fillEventRecord()

void Herwig::QTildeShowerHandler::fillEventRecord ( )

At the end of the Showering, transform ShowerParticle objects into ThePEG particles and fill the event record with them.

Notice that the parent/child relationships and the transformation from ShowerColourLine objects into ThePEG ColourLine ones must be properly handled.

◆ finalStateRadiationEnhancementFactor() [1/2]

double Herwig::QTildeShowerHandler::finalStateRadiationEnhancementFactor ( ) const
inlineprotected

Access the enhancement factor for final-state radiation.

Definition at line 340 of file QTildeShowerHandler.h.

References _finalenhance.

◆ finalStateRadiationEnhancementFactor() [2/2]

void Herwig::QTildeShowerHandler::finalStateRadiationEnhancementFactor ( double  in)
inlineprotected

Set the enhancement factor for final-state radiation.

Definition at line 350 of file QTildeShowerHandler.h.

References _finalenhance.

◆ fullclone()

virtual IBPtr Herwig::QTildeShowerHandler::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 Herwig::ShowerHandler.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, and Herwig::PowhegShowerHandler.

◆ generateCKKW()

virtual HardTreePtr Herwig::QTildeShowerHandler::generateCKKW ( ShowerTreePtr  tree) const
virtual

Generate hard emissions for CKKW etc.

Reimplemented in Herwig::PowhegShowerHandler.

◆ hardEmission()

int Herwig::QTildeShowerHandler::hardEmission ( ) const
inline

Mode for hard emissions.

Definition at line 109 of file QTildeShowerHandler.h.

References _hardEmission.

◆ hardMEC()

bool Herwig::QTildeShowerHandler::hardMEC ( ) const
inlineprotected

Any hard ME correction?

Definition at line 269 of file QTildeShowerHandler.h.

References _hardEmission, and _meCorrMode.

◆ hardOnly()

bool Herwig::QTildeShowerHandler::hardOnly ( ) const
inlineprotected

Only generate the hard emission, for testing only.

Definition at line 518 of file QTildeShowerHandler.h.

References _limitEmissions.

◆ hardScale()

virtual Energy Herwig::QTildeShowerHandler::hardScale ( ) const
inlinevirtual

Return the relevant hard scale to be used in the profile scales.

Reimplemented from Herwig::ShowerHandler.

Definition at line 66 of file QTildeShowerHandler.h.

References muPt.

◆ hardTree() [1/2]

tHardTreePtr Herwig::QTildeShowerHandler::hardTree ( )
inlineprotected

Access to set/get the HardTree currently beinging showered.

The HardTree currently being showered

Definition at line 360 of file QTildeShowerHandler.h.

References _hardtree.

◆ hardTree() [2/2]

void Herwig::QTildeShowerHandler::hardTree ( tHardTreePtr  in)
inlineprotected

The HardTree currently being showered.

Definition at line 365 of file QTildeShowerHandler.h.

References _hardtree.

◆ hardVetoReadOption()

bool Herwig::QTildeShowerHandler::hardVetoReadOption ( ) const
inlineprotected

Switches for vetoing hard emissions.

Returns true if the hard veto read-in is to be applied to only the primary collision and false otherwise.

Definition at line 324 of file QTildeShowerHandler.h.

References _hardVetoReadOption.

◆ Init()

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

◆ initialStateRadiationEnhancementFactor() [1/2]

double Herwig::QTildeShowerHandler::initialStateRadiationEnhancementFactor ( ) const
inlineprotected

Enhancement factors for radiation needed to generate the soft matrix element correction.

Access the enhancement factor for initial-state radiation

Definition at line 335 of file QTildeShowerHandler.h.

References _initialenhance.

◆ initialStateRadiationEnhancementFactor() [2/2]

void Herwig::QTildeShowerHandler::initialStateRadiationEnhancementFactor ( double  in)
inlineprotected

Set the enhancement factor for initial-state radiation.

Definition at line 345 of file QTildeShowerHandler.h.

References _initialenhance.

◆ intrinsicpT()

map< tShowerProgenitorPtr, pair< Energy, double > > & Herwig::QTildeShowerHandler::intrinsicpT ( )
inlineprotected

Access to the intrinsic \(p_T\) for inheriting classes.

Definition at line 427 of file QTildeShowerHandler.h.

References _intrinsic.

◆ ipTon()

bool Herwig::QTildeShowerHandler::ipTon ( ) const
inlineprotected

Switch for intrinsic pT.

Any intrinsic pT?

Definition at line 293 of file QTildeShowerHandler.h.

References _beta, _gamma, _iptmax, _iptrms, and ThePEG::ZERO.

◆ isTruncatedShowerON()

bool Herwig::QTildeShowerHandler::isTruncatedShowerON ( ) const
inlineprotected

Is the truncated shower on?

Definition at line 284 of file QTildeShowerHandler.h.

References _trunc_Mode.

◆ kinematicsReconstructor()

tKinematicsReconstructorPtr Herwig::QTildeShowerHandler::kinematicsReconstructor ( ) const
inline

Access methods to access the objects.

Access to the KinematicsReconstructor object

Definition at line 144 of file QTildeShowerHandler.h.

References _reconstructor.

◆ maximumTries()

unsigned int Herwig::QTildeShowerHandler::maximumTries ( ) const
inlineprotected

Access the maximum number of attempts to generate the shower.

Definition at line 402 of file QTildeShowerHandler.h.

References _maxtry.

◆ MECOn()

bool Herwig::QTildeShowerHandler::MECOn ( ) const
inlineprotected

Switches for matrix element corrections.

Any ME correction?

Definition at line 262 of file QTildeShowerHandler.h.

References _hardEmission.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ partnerFinder()

tPartnerFinderPtr Herwig::QTildeShowerHandler::partnerFinder ( ) const
inline

Access to the PartnerFinder object.

Definition at line 149 of file QTildeShowerHandler.h.

References _partnerfinder.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ progenitor() [1/2]

ShowerProgenitorPtr Herwig::QTildeShowerHandler::progenitor ( )
inlineprotected

Set/Get the ShowerProgenitor for the current shower.

Access the progenitor

Definition at line 411 of file QTildeShowerHandler.h.

References _progenitor.

◆ progenitor() [2/2]

void Herwig::QTildeShowerHandler::progenitor ( ShowerProgenitorPtr  in)
inlineprotected

Set the progenitor.

Definition at line 416 of file QTildeShowerHandler.h.

References _progenitor.

◆ removeVeto()

void Herwig::QTildeShowerHandler::removeVeto ( ShowerVetoPtr  v)
inlineprotected

Remove a veto.

Definition at line 308 of file QTildeShowerHandler.h.

References _vetoes, ThePEG::find(), and v.

◆ setBeamParticle()

void Herwig::QTildeShowerHandler::setBeamParticle ( Ptr< BeamParticleData >::const_pointer  in)
inlineprotected

Set the beam particle data.

Definition at line 380 of file QTildeShowerHandler.h.

References _beam.

◆ setupShower()

virtual vector< ShowerProgenitorPtr > Herwig::QTildeShowerHandler::setupShower ( bool  hard)
protectedvirtual

Extract the particles to be showered, set the evolution scales and apply the hard matrix element correction.

Parameters
hardWhether this is a hard process or decay
Returns
The particles to be showered

◆ showerHardProcess()

virtual void Herwig::QTildeShowerHandler::showerHardProcess ( ShowerTreePtr  ,
XCPtr   
)
virtual

Members to perform the shower.

Perform the shower of the hard process

◆ showerHardProcessVeto()

virtual bool Herwig::QTildeShowerHandler::showerHardProcessVeto ( ) const
inlinevirtual

Hook to allow vetoing of event after showering hard sub-process as in e.g.

MLM merging.

Reimplemented from Herwig::ShowerHandler.

Reimplemented in Herwig::AlpGenHandlerOL, and Herwig::FxFxHandler.

Definition at line 74 of file QTildeShowerHandler.h.

◆ softCorrelations()

unsigned int Herwig::QTildeShowerHandler::softCorrelations ( ) const
inline

Access to switches for spin correlations.

Soft correlations

Definition at line 124 of file QTildeShowerHandler.h.

References _softOpt.

◆ softMEC()

bool Herwig::QTildeShowerHandler::softMEC ( ) const
inlineprotected

Any soft ME correction?

Definition at line 276 of file QTildeShowerHandler.h.

References _hardEmission, and _meCorrMode.

◆ spaceLikeDecayShower()

virtual bool Herwig::QTildeShowerHandler::spaceLikeDecayShower ( tShowerParticlePtr  particle,
const ShowerParticle::EvolutionScales maxScales,
Energy  minimumMass,
ShowerInteraction  ,
Branching  fb 
)
protectedvirtual

If does the forward evolution of the input on-shell particle involved in a decay (and recursively for all its time-like radiation products).

accepting only emissions which conforms to the showerVariables.

Parameters
particleThe particle to be showered
maxscaleThe maximum scale for the shower.
minimumMassThe minimum mass of the final-state system

◆ spaceLikeShower()

virtual bool Herwig::QTildeShowerHandler::spaceLikeShower ( tShowerParticlePtr  particle,
PPtr  beam,
ShowerInteraction   
)
protectedvirtual

It does the backward evolution of the space-like input particle (and recursively for all its time-like radiation products).

accepting only emissions which conforms to the showerVariables. If at least one emission has occurred then the method returns true

Parameters
particleThe particle to be showered
beamThe beam particle

◆ splittingGenerator()

tSplittingGeneratorPtr Herwig::QTildeShowerHandler::splittingGenerator ( ) const
inline

Access to the flags and shower variables.

Get the SplittingGenerator

Definition at line 104 of file QTildeShowerHandler.h.

References _splittingGenerator.

◆ timeLikeShower()

virtual bool Herwig::QTildeShowerHandler::timeLikeShower ( tShowerParticlePtr  particle,
ShowerInteraction  ,
Branching  fb,
bool  first 
)
protectedvirtual

Methods to perform the evolution of an individual particle, including recursive calling on the products.

It does the forward evolution of the time-like input particle (and recursively for all its radiation products). accepting only emissions which conforms to the showerVariables and soft matrix element correction. If at least one emission has occurred then the method returns true.

Parameters
particleThe particle to be showered

Member Data Documentation

◆ _beam

Ptr<BeamParticleData>::const_pointer Herwig::QTildeShowerHandler::_beam
private

The beam particle data for the current initial-state shower.

Definition at line 733 of file QTildeShowerHandler.h.

Referenced by beamParticle(), and setBeamParticle().

◆ _beta

double Herwig::QTildeShowerHandler::_beta
private

Proportion of inverse quadratic intrinsic pT distribution.

Definition at line 672 of file QTildeShowerHandler.h.

Referenced by ipTon().

◆ _currenttree

ShowerTreePtr Herwig::QTildeShowerHandler::_currenttree
private

The ShowerTree currently being showered.

Definition at line 707 of file QTildeShowerHandler.h.

Referenced by currentTree().

◆ _decayme

HwDecayerBasePtr Herwig::QTildeShowerHandler::_decayme
private

Decayer.

Definition at line 702 of file QTildeShowerHandler.h.

◆ _evolutionScheme

unsigned int Herwig::QTildeShowerHandler::_evolutionScheme
private

Control of the reconstruction option.

Definition at line 653 of file QTildeShowerHandler.h.

◆ _finalenhance

double Herwig::QTildeShowerHandler::_finalenhance
private

Enhancement factor for final-state radiation.

Definition at line 727 of file QTildeShowerHandler.h.

Referenced by finalStateRadiationEnhancementFactor().

◆ _fullShowerVetoes

vector<FullShowerVetoPtr> Herwig::QTildeShowerHandler::_fullShowerVetoes
private

Full Shower Vetoes.

Definition at line 748 of file QTildeShowerHandler.h.

◆ _gamma

Energy Herwig::QTildeShowerHandler::_gamma
private

Parameter for inverse quadratic: 2*Beta*Gamma/(sqr(Gamma)+sqr(intrinsicpT))

Definition at line 677 of file QTildeShowerHandler.h.

Referenced by ipTon().

◆ _hardEmission

int Herwig::QTildeShowerHandler::_hardEmission
private

Mode for the hard emissions.

Definition at line 783 of file QTildeShowerHandler.h.

Referenced by hardEmission(), hardMEC(), MECOn(), and softMEC().

◆ _hardEmissionWarn

bool Herwig::QTildeShowerHandler::_hardEmissionWarn
staticprivate

True if no warnings about incorrect hard emission mode setting have been issued yet.

Definition at line 799 of file QTildeShowerHandler.h.

◆ _hardme

HwMEBasePtr Herwig::QTildeShowerHandler::_hardme
private

Matrix element.

Definition at line 697 of file QTildeShowerHandler.h.

◆ _hardPOWHEG

bool Herwig::QTildeShowerHandler::_hardPOWHEG
private

Option for hard radiation in POWHEG events.

Definition at line 793 of file QTildeShowerHandler.h.

◆ _hardtree

HardTreePtr Herwig::QTildeShowerHandler::_hardtree
private

The HardTree currently being showered.

Definition at line 712 of file QTildeShowerHandler.h.

Referenced by hardTree().

◆ _hardVetoReadOption

bool Herwig::QTildeShowerHandler::_hardVetoReadOption
private

If hard veto pT scale is being read-in this determines whether the read-in value is applied to primary and secondary (MPI) scatters or just the primary one, with the usual computation of the veto being performed for the secondary (MPI) scatters.

Definition at line 662 of file QTildeShowerHandler.h.

Referenced by hardVetoReadOption().

◆ _initialenhance

double Herwig::QTildeShowerHandler::_initialenhance
private

Radiation enhancement factors for use with the veto algorithm if needed by the soft matrix element correction.

Enhancement factor for initial-state radiation

Definition at line 722 of file QTildeShowerHandler.h.

Referenced by initialStateRadiationEnhancementFactor().

◆ _intrinsic

map<tShowerProgenitorPtr,pair<Energy,double> > Herwig::QTildeShowerHandler::_intrinsic
private

Storage of the intrinsic \(p_t\) of the particles.

Definition at line 738 of file QTildeShowerHandler.h.

Referenced by intrinsicpT().

◆ _iptmax

Energy Herwig::QTildeShowerHandler::_iptmax
private

Upper bound on intrinsic pT for inverse quadratic.

Definition at line 682 of file QTildeShowerHandler.h.

Referenced by ipTon().

◆ _iptrms

Energy Herwig::QTildeShowerHandler::_iptrms
private

rms intrinsic pT of Gaussian distribution

Definition at line 667 of file QTildeShowerHandler.h.

Referenced by ipTon().

◆ _limitEmissions

unsigned int Herwig::QTildeShowerHandler::_limitEmissions
private

Limit the number of emissions for testing.

Definition at line 687 of file QTildeShowerHandler.h.

Referenced by hardOnly().

◆ _maxtry

unsigned int Herwig::QTildeShowerHandler::_maxtry
private

Maximum number of tries to generate the shower of a particular tree.

Definition at line 643 of file QTildeShowerHandler.h.

Referenced by maximumTries().

◆ _meCorrMode

unsigned int Herwig::QTildeShowerHandler::_meCorrMode
private

Matrix element correction switch.

Definition at line 648 of file QTildeShowerHandler.h.

Referenced by hardMEC(), and softMEC().

◆ _missingTruncWarn

bool Herwig::QTildeShowerHandler::_missingTruncWarn
staticprivate

True if no warnings about missing truncated shower have been issued yet.

Definition at line 805 of file QTildeShowerHandler.h.

◆ _nfs

unsigned int Herwig::QTildeShowerHandler::_nfs
private

Number of FS emissions.

Definition at line 768 of file QTildeShowerHandler.h.

◆ _nis

unsigned int Herwig::QTildeShowerHandler::_nis
private

number of IS emissions

Definition at line 763 of file QTildeShowerHandler.h.

◆ _nReWeight

unsigned int Herwig::QTildeShowerHandler::_nReWeight
private

Number of iterations for reweighting.

Definition at line 753 of file QTildeShowerHandler.h.

◆ _partnerfinder

PartnerFinderPtr Herwig::QTildeShowerHandler::_partnerfinder
private

Pointer to the PartnerFinder object.

Definition at line 825 of file QTildeShowerHandler.h.

Referenced by partnerFinder().

◆ _progenitor

ShowerProgenitorPtr Herwig::QTildeShowerHandler::_progenitor
private

The progenitor of the current shower.

Definition at line 692 of file QTildeShowerHandler.h.

Referenced by progenitor().

◆ _reconstructor

KinematicsReconstructorPtr Herwig::QTildeShowerHandler::_reconstructor
private

Pointer to the various objects.

Pointer to the KinematicsReconstructor object

Definition at line 820 of file QTildeShowerHandler.h.

Referenced by kinematicsReconstructor().

◆ _reWeight

bool Herwig::QTildeShowerHandler::_reWeight
private

Whether or not we are reweighting.

Definition at line 758 of file QTildeShowerHandler.h.

◆ _softOpt

unsigned int Herwig::QTildeShowerHandler::_softOpt
private

Option for the kernal for soft correlations.

Definition at line 788 of file QTildeShowerHandler.h.

Referenced by correlations(), and softCorrelations().

◆ _splittingGenerator

SplittingGeneratorPtr Herwig::QTildeShowerHandler::_splittingGenerator
private

Pointer to the splitting generator.

Definition at line 638 of file QTildeShowerHandler.h.

Referenced by splittingGenerator().

◆ _trunc_Mode

bool Herwig::QTildeShowerHandler::_trunc_Mode
private

Truncated shower switch.

Definition at line 778 of file QTildeShowerHandler.h.

Referenced by isTruncatedShowerON().

◆ _vetoes

vector<ShowerVetoPtr> Herwig::QTildeShowerHandler::_vetoes
private

Vetoes.

Definition at line 743 of file QTildeShowerHandler.h.

Referenced by addVeto(), and removeVeto().

◆ decay_

ShowerDecayMap Herwig::QTildeShowerHandler::decay_
private

The ShowerTree for the decays.

Definition at line 625 of file QTildeShowerHandler.h.

◆ done_

vector<ShowerTreePtr> Herwig::QTildeShowerHandler::done_
private

The ShowerTrees for which the initial shower.

Definition at line 630 of file QTildeShowerHandler.h.

◆ hard_

ShowerTreePtr Herwig::QTildeShowerHandler::hard_
private

Stuff from the ShowerHandler.

The ShowerTree for the hard process

Definition at line 620 of file QTildeShowerHandler.h.

◆ interaction_

ShowerInteraction Herwig::QTildeShowerHandler::interaction_
private

The option for wqhich interactions to use.

Definition at line 773 of file QTildeShowerHandler.h.

◆ muPt

Energy Herwig::QTildeShowerHandler::muPt
private

The relevant hard scale to be used in the profile scales.

Definition at line 810 of file QTildeShowerHandler.h.

Referenced by hardScale().


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