thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::SimpleBaryonRemnantDecayer Class Reference

The SimpleBaryonRemnantDecayer class inherits from the RemnantDecayer class and is able to decay RemnantParticles produced by the SoftRemnantHandler class for the cases when a single parton has been extracted from a baryon. More...

#include <SimpleBaryonRemnantDecayer.h>

Inheritance diagram for ThePEG::SimpleBaryonRemnantDecayer:

Classes

struct  BaryonContent
 Simple struct to store info about baryon quark and di-quark constituents. More...
 
struct  DecayFailed
 Exception thrown if the decay of a remnant was impossible. More...
 
struct  NoDISRespect
 Warning Exception used when DIS kinematics was not respected. More...
 

Public Types

typedef Ptr< ZGenerator >::pointer ZGPtr
 A pointer to a ZGenerator object. More...
 
typedef Ptr< FlavourGenerator >::pointer FlGPtr
 A pointer to a FlavourGenerator object. More...
 
- Public Types inherited from ThePEG::RemnantDecayer
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. More...
 
- 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

ZGeneratorzGenerator () const
 Return a reference to the object responsible for generating momentum fractions in case of more than one remnant.
 
FlavourGeneratorflavourGenerator () const
 Return a reference to the object responsible for handling the flavour contents of a baryon.
 
Energy margin () const
 Return the energy margin to be added to the sum of the parent and parton masses to determine if it is possible to construct the remnants with the given (upper limit of the) virtuality of the extracted parton.
 
bool specialValence () const
 If true an extracted valens quark will always give a di-quark remnant.
 
const BaryonContentgetBaryonInfo (tcPDPtr baryon) const
 Return info about baryon quark and di-quark constituents.
 
Standard constructors and destructors.
 SimpleBaryonRemnantDecayer ()
 The default constructor.
 
 SimpleBaryonRemnantDecayer (const SimpleBaryonRemnantDecayer &x)
 The copy constructor.
 
virtual ~SimpleBaryonRemnantDecayer ()
 The destructor.
 
Virtual functions required by the RemnantDecayer class.
virtual bool accept (const DecayMode &dm) const
 Check if this decayer can perfom the decay specified by the given decay mode. More...
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p, Step &step) const
 Perform a decay for a given DecayMode and a given Particle instance. More...
 
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. More...
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::RemnantDecayer
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.
 
 RemnantDecayer ()
 The default constructor.
 
virtual ~RemnantDecayer ()
 The destructor.
 
virtual bool needsFullStep () const
 Return true if this Decayer need to access the full current step when a particle is decayed. More...
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p) const
 Perform a decay for a given DecayMode and a given Particle instance. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::Decayer
Ptr< Amplitude >::pointer amplitude () const
 Return an amplitude associated with this decay matrix element. More...
 
virtual double brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const
 Calculate branching ratio. More...
 
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 Calculate branching ratio. More...
 
virtual ParticleVector getChildren (const DecayMode &dm, const Particle &parent) const
 Produce the children. More...
 
virtual void finalBoost (const Particle &parent, const ParticleVector &children) const
 Boost the decay products. More...
 
virtual void setScales (const Particle &parent, const ParticleVector &children) const
 Set the scales. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
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 StandardModelBaseSM () 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.
 
virtual ~HandlerBaseT ()
 Destructor.
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete. More...
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
 Named (const Named &)=default
 Explicit default copy-constructor (too avoid compiler warnings)
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::RemnantDecayer
static tPVector decayRemnants (const tPVector &particles, Step &step)
 Static function to decay al remnants among the given particles. More...
 
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::Decayer
static ParticleVector DecayParticle (tPPtr parent, Step &step, long maxtry=1000)
 Static function to administer the decay of a particle. More...
 
static void Init ()
 Standard Init function used to initialize the interfaces.
 
- 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. More...
 

Protected Member Functions

Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
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.
 
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::RemnantDecayer
tRemPDPtr data (tcRemPPtr remnant) const
 Access the RemnantData object of a remnant.
 
tcPPtr parent (tcRemPPtr remnant) const
 Access the parent of a remnant.
 
const PVectorextracted (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. More...
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More...
 
template<typename PtrT >
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.
 
 Interfaced ()
 Protected default constructor.
 
 Interfaced (const string &newName)
 Protected constructor taking a name as argument.
 
 Interfaced (const Interfaced &i)
 Protected copy-constructor.
 
void setGenerator (tEGPtr generator)
 Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Private Member Functions

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

Private Attributes

ZGPtr theZGenerator
 The object responsible for generating momentum fractions in case of more than one remnant.
 
FlGPtr theFlavourGenerator
 The object responsible for handling the flavour contents of a baryon.
 
Energy theMargin
 The energy margin to be added to the sum of the parent and parton masses to determine if it is possible to construct the remnants with the given (upper limit of the) virtuality of the extracted parton.
 
bool useSpecialValence
 If true an extracted valens quark will always give a di-quark remnant.
 
map< tcPDPtr, BaryonContentbaryonmap
 A map of info about baryon quark and di-quark constituents.
 

Static Private Attributes

static ClassDescription< SimpleBaryonRemnantDecayerinitSimpleBaryonRemnantDecayer
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Static Protected Member Functions inherited from ThePEG::RemnantDecayer
static LorentzRotation getZBoost (const LorentzMomentum &p0, const LorentzMomentum &p)
 Return a small boost along the z-axis. More...
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 Register an Interfaced object with the Repository.
 
static void registerRepository (IBPtr, string newName)
 Register an Interfaced object with the Repository, giving it a name.
 
- Protected Attributes inherited from ThePEG::RemnantDecayer
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.
 

Detailed Description

The SimpleBaryonRemnantDecayer class inherits from the RemnantDecayer class and is able to decay RemnantParticles produced by the SoftRemnantHandler class for the cases when a single parton has been extracted from a baryon.

See also
The interfaces defined for SimpleBaryonRemnantDecayer.

Definition at line 31 of file SimpleBaryonRemnantDecayer.h.

Member Typedef Documentation

◆ FlGPtr

A pointer to a FlavourGenerator object.

Definition at line 38 of file SimpleBaryonRemnantDecayer.h.

◆ ZGPtr

A pointer to a ZGenerator object.

Definition at line 36 of file SimpleBaryonRemnantDecayer.h.

Member Function Documentation

◆ accept()

virtual bool ThePEG::SimpleBaryonRemnantDecayer::accept ( const DecayMode dm) const
virtual

Check if this decayer can perfom the decay specified by the given decay mode.

Parameters
dmthe DecayMode describing the decay.
Returns
true if this decayer can handle the given mode, otherwise false.

Reimplemented from ThePEG::RemnantDecayer.

Referenced by SimpleBaryonRemnantDecayer().

◆ checkExtract()

virtual bool ThePEG::SimpleBaryonRemnantDecayer::checkExtract ( tcPPtr  parent,
tcPPtr  extracted,
const LorentzMomentum pnew 
) const
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 from ThePEG::RemnantDecayer.

Referenced by SimpleBaryonRemnantDecayer().

◆ clone()

virtual IBPtr ThePEG::SimpleBaryonRemnantDecayer::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Referenced by specialValence().

◆ decay()

virtual ParticleVector ThePEG::SimpleBaryonRemnantDecayer::decay ( const DecayMode dm,
const Particle p,
Step step 
) const
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.

Parameters
dmthe DecayMode describing the decay.
pthe Particle instance to be decayed.
stepthe current step in which to find possible siblings to shuffle energy with.
Returns
a ParticleVector containing the decay products.

Implements ThePEG::RemnantDecayer.

Referenced by SimpleBaryonRemnantDecayer().

◆ doinit()

virtual void ThePEG::SimpleBaryonRemnantDecayer::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 ThePEG::RemnantDecayer.

Referenced by SimpleBaryonRemnantDecayer().

◆ fullclone()

virtual IBPtr ThePEG::SimpleBaryonRemnantDecayer::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.

Referenced by specialValence().

◆ Init()

static void ThePEG::SimpleBaryonRemnantDecayer::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.

Referenced by SimpleBaryonRemnantDecayer().

◆ operator=()

SimpleBaryonRemnantDecayer& ThePEG::SimpleBaryonRemnantDecayer::operator= ( const SimpleBaryonRemnantDecayer )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::SimpleBaryonRemnantDecayer::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.

Referenced by SimpleBaryonRemnantDecayer().

◆ persistentOutput()

void ThePEG::SimpleBaryonRemnantDecayer::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by SimpleBaryonRemnantDecayer().

Member Data Documentation

◆ initSimpleBaryonRemnantDecayer

ClassDescription<SimpleBaryonRemnantDecayer> ThePEG::SimpleBaryonRemnantDecayer::initSimpleBaryonRemnantDecayer
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 268 of file SimpleBaryonRemnantDecayer.h.


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