ThePEG 2.3.0
|
The RemnantDecayer class is the base class to be used for all decayers capable of decaying a RemnantParticle object produced by a SoftRemnantHandler object. More...
#include <RemnantDecayer.h>
Classes | |
struct | SubSystemFail |
Exception used if getSubSystem fails. More... | |
Public Types | |
enum | RecoilOption { boostAll , boostFinal , copyFinal } |
Enumerate the options for how to distribute recoils in the hard subsystem when taking energy to produce remnants. More... | |
typedef Ptr< PtGenerator >::pointer | PtGPtr |
A pointer to a PtGenerator object. | |
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 Member Functions | |
Standard constructors and destructors. | |
RemnantDecayer () | |
The default constructor. | |
virtual | ~RemnantDecayer () |
The destructor. | |
Public Member Functions inherited from ThePEG::Decayer | |
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 double | brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const |
Calculate branching ratio. | |
virtual double | brat (const DecayMode &dm, const Particle &p, double oldbrat) const |
Calculate branching ratio. | |
virtual ParticleVector | getChildren (const DecayMode &dm, const Particle &parent) const |
Produce the children. | |
virtual void | finalBoost (const Particle &parent, const ParticleVector &children) const |
Boost the decay products. | |
virtual void | setScales (const Particle &parent, const ParticleVector &children) const |
Set the scales. | |
Ptr< Amplitude >::pointer | amplitude () const |
Return an amplitude associated with this decay matrix element. | |
Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom > | |
virtual | ~HandlerBaseT () |
Destructor. | |
double | rnd () const |
Return a simple flat random number in the range ]0,1[. | |
double | rnd (double xu) const |
Return a simple flat random number in the range ]0,xu[. | |
double | rnd (double xl, double xu) const |
Return a simple flat random number in the range ]xl,xu[. | |
bool | rndbool () const |
Return true with 50% probability. | |
bool | rndbool (double p) const |
Return a true with probability p. | |
bool | rndbool (double p1, double p2) const |
Return a true with probability p1/(p1+p2). | |
int | rndsign (double p1, double p2, double p3) const |
Return -1, 0, or 1 with relative probabilities p1, p2, p3. | |
int | rnd2 (double p0, double p1) const |
Return an integer \(i\) with probability p \(i\)/(p0+p1). | |
int | rnd3 (double p0, double p1, double p2) const |
Return an integer \(i\) with probability p \(i\)/(p0+p1+p2). | |
int | rnd4 (double p0, double p1, double p2, double p3) const |
Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3). | |
long | irnd (long xu=2) const |
Return a simple flat random integrer number in the range [0,xu[. | |
long | irnd (long xl, long xu) const |
Return a simple flat random integrer number in the range [xl,xu[. | |
const StandardModelBase & | SM () const |
Return a reference to the object containing the standard model parameters for this run. | |
tSMPtr | standardModel () const |
Return a pointer to the object containing the standard model parameters for this run. | |
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. | |
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. | |
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. | |
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. | |
string | name () const |
Returns the name of this object, without the path. | |
string | path () const |
Returns the path to this object including the trailing '/'. | |
string | comment () const |
Returns a comment assigned to this object. | |
void | setup (istream &is) |
Read setup info from a standard istream is. | |
void | update () |
Calls the doupdate() function with recursion prevention. | |
void | init () |
Calls the doinit() function with recursion prevention. | |
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(). | |
virtual IBPtr | fullclone () const |
Return a full clone of this object possibly doing things to the clone to make it sane. | |
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 void | debugme () const |
Print out debugging information for this object on std::cerr. | |
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. | |
virtual void | debugme () const |
Print out debugging information for this object on std::cerr. | |
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. | |
Protected Member Functions | |
Standard Interfaced functions. | |
virtual void | doinit () |
Initialize this object after the setup phase before saving an EventGenerator to disk. | |
virtual bool | preInitialize () const |
Return true if this object needs to be initialized before all other objects because it needs to extract cuts from the event file. | |
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. | |
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 void | readSetup (istream &is) |
Read setup info from a standard istream is. | |
virtual void | doupdate () |
Check sanity of the object during the setup phase. | |
virtual void | doinitrun () |
Initialize this object. | |
virtual void | dofinish () |
Finalize this object. | |
virtual IVector | getReferences () |
Return a vector of all pointers to Interfaced objects used in this object. | |
virtual void | rebind (const TranslationMap &) |
Rebind pointer to other Interfaced objects. | |
virtual IBPtr | clone () const =0 |
Return a simple clone of this object. | |
InterfacedBase () | |
Protected default constructor. | |
InterfacedBase (string newName) | |
Protected constructor with the name given as argument. | |
InterfacedBase (const InterfacedBase &i) | |
Protected copy-constructor. | |
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. | |
Functions used by the persistent I/O system. | |
int | respectDIS |
If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that \(x\) and \(Q^2\) is unmodified. | |
RecoilOption | theRecoilOption |
The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants. | |
PtGPtr | thePTGenerator |
An object capable of generating an intrinsic transverse momentum of the created remnants. | |
static AbstractClassDescription< RemnantDecayer > | initRemnantDecayer |
The static object used to initialize the description of this class. | |
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. | |
RemnantDecayer & | operator= (const RemnantDecayer &)=delete |
The assignment operator is private and must never be called. | |
Virtual functions required by the Decayer class. | |
virtual bool | accept (const DecayMode &dm) const |
Check if this decayer can perfom the decay specified by the given decay mode. | |
virtual bool | needsFullStep () const |
Return true if this Decayer need to access the full current step when a particle is decayed. | |
virtual ParticleVector | decay (const DecayMode &dm, const Particle &p, Step &step) const =0 |
Perform a decay for a given DecayMode and a given Particle instance. | |
virtual ParticleVector | decay (const DecayMode &dm, const Particle &p) const |
Perform a decay for a given DecayMode and a given Particle instance. | |
virtual bool | canHandle (tcPDPtr parent, tcPDPtr extracted) const |
Return true if this decayer can handle the extraction of the extracted parton from the given particle. | |
virtual bool | checkExtract (tcPPtr parent, tcPPtr extracted, const LorentzMomentum &pnew) const |
Return true if this decayer can handle the extraction of the extracted parton instance from the given particle instance. | |
virtual bool | multiCapable () const |
Return true if this decayed can extract more than one parton from a particle. | |
RecoilOption | recoilOption () const |
The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants. | |
int | respectDISKinematics () const |
If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that \(x\) and \(Q^2\) is unmodified. | |
PtGPtr | pTGenerator () const |
An object capable of generating an intrinsic transverse momentum of the created remnants. | |
static tPVector | decayRemnants (const tPVector &particles, Step &step) |
Static function to decay al remnants among the given particles. | |
tRemPDPtr | data (tcRemPPtr remnant) const |
Access the RemnantData object of a remnant. | |
tcPPtr | parent (tcRemPPtr remnant) const |
Access the parent of a remnant. | |
const PVector & | extracted (tcRemPPtr remnant) const |
Access the vector of extracted particles of a remnant. | |
virtual void | fillSubSystem (tPPtr p, set< tPPtr > &sub) const |
Recursively find all particles produced from an extracted parton. | |
virtual tPVector | getSubSystem (tcPPtr parent, tPPtr parton) const |
Return the system of particles from the hard subsystem which may be used to shuffle momenta to get the remnants on-shell. | |
static LorentzRotation | getZBoost (const LorentzMomentum &p0, const LorentzMomentum &p) |
Return a small boost along the z-axis. | |
Additional Inherited Members | |
Static Public Member Functions inherited from ThePEG::Decayer | |
static void | Init () |
Standard Init function used to initialize the interfaces. | |
static ParticleVector | DecayParticle (tPPtr parent, Step &step, long maxtry=1000) |
Static function to administer the decay of a particle. | |
Static Public Member Functions inherited from ThePEG::HandlerBase | |
static void | Init () |
Standard Init function used to initialize the interface. | |
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. | |
Public Attributes inherited from ThePEG::Pointer::ReferenceCounted | |
const unsigned long | uniqueId |
The unique ID. | |
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. | |
The RemnantDecayer class is the base class to be used for all decayers capable of decaying a RemnantParticle object produced by a SoftRemnantHandler object.
A derived class must implement the decay(const DecayMode &, const Particle &, Step &) function, while the decay(const DecayMode &, const Particle &) function should never be called.
Definition at line 34 of file RemnantDecayer.h.
typedef Ptr<PtGenerator>::pointer ThePEG::RemnantDecayer::PtGPtr |
A pointer to a PtGenerator object.
Definition at line 39 of file RemnantDecayer.h.
Enumerate the options for how to distribute recoils in the hard subsystem when taking energy to produce remnants.
Enumerator | |
---|---|
boostAll | Boost all particles in the hard subsystem. |
boostFinal | Boost only final state particles in hard subsystem. |
copyFinal | Boost copies of final state particles in hard subsystem. |
Definition at line 47 of file RemnantDecayer.h.
|
inline |
The default constructor.
Definition at line 60 of file RemnantDecayer.h.
|
virtual |
Check if this decayer can perfom the decay specified by the given decay mode.
dm | the DecayMode describing the decay. |
Implements ThePEG::Decayer.
Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.
Return true if this decayer can handle the extraction of the extracted parton from the given particle.
Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.
|
virtual |
Return true if this decayer can handle the extraction of the extracted parton instance from the given particle instance.
pnew is the momentum of the resulting remnant. The default version simply checks if the energy is positive.
Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.
|
inlineprotected |
Access the RemnantData object of a remnant.
Definition at line 168 of file RemnantDecayer.h.
|
virtual |
Perform a decay for a given DecayMode and a given Particle instance.
Implements ThePEG::Decayer.
|
pure virtual |
Perform a decay for a given DecayMode and a given Particle instance.
This version allows the decaying particle to borrow energy/momentum from its sublings in the current step. This will be called by the standard DecayHandler if the needsFullStep() function returns true.
dm | the DecayMode describing the decay. |
p | the Particle instance to be decayed. |
step | the current step in which to find possible siblings to shuffle energy with. |
Reimplemented from ThePEG::Decayer.
Implemented in ThePEG::SimpleBaryonRemnantDecayer.
|
static |
Static function to decay al remnants among the given particles.
The decay products are inserted in the step provided.
|
protectedvirtual |
Initialize this object after the setup phase before saving an EventGenerator to disk.
InitException | if object could not be initialized properly. |
Reimplemented from ThePEG::InterfacedBase.
Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.
|
inlineprotected |
Access the vector of extracted particles of a remnant.
Definition at line 178 of file RemnantDecayer.h.
|
protectedvirtual |
Return the system of particles from the hard subsystem which may be used to shuffle momenta to get the remnants on-shell.
In this version the particles are ordered in rapidity with the ones closest to the remnant direction comes first. Other orderings can be enforced by sub-classes.
|
staticprotected |
Return a small boost along the z-axis.
To cure rounding errors when making large boosts it is sometimes necessary to correct the plus (or minus) lightcone component with a small boost along the z-axis. The resulting boost is constructed so that the momentum p0 would be transformed to have the sam z-value as the momentum p.
|
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.
|
virtual |
Return true if this Decayer need to access the full current step when a particle is decayed.
If true is returned the standard Decay Handler will call the decay(const DecayMode&,const Particle&,Step&) function rather than the decay(const DecayMode&,const Particle&) function.
Reimplemented from ThePEG::Decayer.
|
privatedelete |
The assignment operator is private and must never be called.
In fact, it should not even be implemented.
|
inlineprotected |
Access the parent of a remnant.
Definition at line 173 of file RemnantDecayer.h.
void ThePEG::RemnantDecayer::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. |
void ThePEG::RemnantDecayer::persistentOutput | ( | PersistentOStream & | os | ) | const |
Function used to write out object persistently.
os | the persistent output stream written to. |
|
protectedvirtual |
Return true if this object needs to be initialized before all other objects because it needs to extract cuts from the event file.
Reimplemented from ThePEG::InterfacedBase.
Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.
|
inline |
An object capable of generating an intrinsic transverse momentum of the created remnants.
Definition at line 152 of file RemnantDecayer.h.
References thePTGenerator.
|
inline |
The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants.
Definition at line 139 of file RemnantDecayer.h.
References theRecoilOption.
|
inline |
If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that \(x\) and \(Q^2\) is unmodified.
Definition at line 146 of file RemnantDecayer.h.
References respectDIS.
|
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 286 of file RemnantDecayer.h.
|
mutableprotected |
If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that \(x\) and \(Q^2\) is unmodified.
Definition at line 264 of file RemnantDecayer.h.
Referenced by respectDISKinematics().
|
private |
An object capable of generating an intrinsic transverse momentum of the created remnants.
Definition at line 278 of file RemnantDecayer.h.
Referenced by pTGenerator().
|
private |
The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants.
Definition at line 272 of file RemnantDecayer.h.
Referenced by recoilOption().