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

The DalitzBase class provides a base class for the implementation of three-body Dalitz decays. More...

#include <DalitzBase.h>

Inheritance diagram for Herwig::DalitzBase:

Public Member Functions

 DalitzBase ()
 The default constructor.
 
virtual int modeNumber (bool &cc, tcPDPtr parent, const tPDVector &children) const
 Which of the possible decays is required.
 
virtual void dataBaseOutput (ofstream &os, bool header) const
 Output the setup information for the particle database.
 
string addChannel (string arg)
 Set the parameters for a decay mode.
 
string setExternal (string arg)
 Set the parameters for a decay mode.
 
- Public Member Functions inherited from Herwig::DecayIntegrator
 DecayIntegrator ()
 The default constructor.
 
virtual bool accept (tcPDPtr parent, const tPDVector &children) const
 Check if this decayer can perfom the decay for a particular mode.
 
virtual ParticleVector decay (const Particle &parent, const tPDVector &children) const
 For a given decay mode and a given particle instance, perform the decay and return the decay products.
 
virtual int modeNumber (bool &cc, tcPDPtr parent, const tPDVector &children) const =0
 Which of the possible decays is required.
 
int imode () const
 The mode being used for this decay.
 
void addMode (PhaseSpaceModePtr mode) const
 Add a phase-space mode to the list.
 
virtual double me2 (const int ichan, const Particle &part, const tPDVector &outgoing, const vector< Lorentz5Momentum > &momenta, MEOption meopt) const =0
 Return the matrix element squared for a given mode and phase-space channel.
 
virtual void constructSpinInfo (const Particle &part, ParticleVector outgoing) const =0
 Construct the SpinInfos for the particles produced in the decay.
 
virtual void dataBaseOutput (ofstream &os, bool header) const
 Output the setup information for the particle database.
 
void setPartialWidth (const DecayMode &dm, int imode)
 Set the code for the partial width.
 
virtual bool twoBodyMEcode (const DecayMode &, int &mecode, double &coupling) const
 Specify the \(1\to2\) matrix element to be used in the running width calculation.
 
virtual WidthCalculatorBasePtr threeBodyMEIntegrator (const DecayMode &dm) const
 Method to return an object to calculate the 3 (or higher body) partial width.
 
virtual double threeBodyMatrixElement (const int imode, const Energy2 q2, const Energy2 s3, const Energy2 s2, const Energy2 s1, const Energy m1, const Energy m2, const Energy m3) const
 The matrix element to be integrated for the three-body decays as a function of the invariant masses of pairs of the outgoing particles.
 
virtual InvEnergy threeBodydGammads (const int imode, const Energy2 q2, const Energy2 s, const Energy m1, const Energy m2, const Energy m3) const
 The differential three body decay rate with one integral performed.
 
int findMode (const DecayMode &dm)
 Finds the phase-space mode corresponding to a given decay mode.
 
ParticleVector generatePhotons (const Particle &p, ParticleVector children)
 Members for the generation of QED radiation in the decays.
 
bool canGeneratePhotons ()
 check if photons can be generated in the decay
 
virtual double oneLoopVirtualME (unsigned int imode, const Particle &part, const ParticleVector &products)
 The one-loop virtual correction.
 
bool hasOneLoopME ()
 Whether or not the one loop matrix element is implemented.
 
virtual InvEnergy2 realEmissionME (unsigned int imode, const Particle &part, ParticleVector &products, unsigned int iemitter, double ctheta, double stheta, const LorentzRotation &rot1, const LorentzRotation &rot2)
 The real emission matrix element.
 
bool hasRealEmissionME ()
 Whether or not the real emission matrix element is implemented.
 
bool warnings () const
 
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 Herwig::HwDecayerBase
 HwDecayerBase ()
 The default constructor.
 
virtual bool accept (const DecayMode &dm) const
 Check if this decayer can perfom the decay specified by the given decay mode.
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p) const
 Perform a decay for a given DecayMode and a given Particle instance.
 
virtual POWHEGType hasPOWHEGCorrection ()
 Has a POWHEG style correction.
 
virtual bool hasMECorrection ()
 Has an old fashioned ME correction.
 
virtual void initializeMECorrection (RealEmissionProcessPtr, double &, double &)
 Initialize the ME correction.
 
virtual RealEmissionProcessPtr applyHardMatrixElementCorrection (RealEmissionProcessPtr)
 Apply the hard matrix element correction to a given hard process or decay.
 
virtual bool softMatrixElementVeto (PPtr parent, PPtr progenitor, const bool &fs, const Energy &highestpT, const vector< tcPDPtr > &ids, const double &z, const Energy &scale, const Energy &pT)
 Apply the soft matrix element correction.
 
virtual RealEmissionProcessPtr generateHardest (RealEmissionProcessPtr)
 Apply the POWHEG style correction.
 
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 initialize () const
 Access to the initialize variable.
 
bool databaseOutput () const
 Access the database output variable.
 
- Public Member Functions inherited from ThePEG::Decayer
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
virtual bool accept (const DecayMode &dm) const=0
 
virtual bool needsFullStep () const
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p) const=0
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p, Step &step) const
 
virtual double brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const
 
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 
virtual ParticleVector getChildren (const DecayMode &dm, const Particle &parent) const
 
virtual void finalBoost (const Particle &parent, const ParticleVector &children) const
 
virtual void setScales (const Particle &parent, const ParticleVector &children) const
 
Ptr< Amplitude >::pointer amplitude () const
 
- 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
 

Standard Interfaced functions.

InvEnergy rParent_
 The radii for the Blatt-Weisskopf form factors.
 
bool useAllK0_
 Take all \(K_0\) mesnos to be the same.
 
vector< DalitzResonancePtr > resonances_
 Vector containing the intermediate resonances.
 
vector< KMatrixPtr > kMatrix_
 Any \(K\)-matrices for the decay.
 
double maxWgt_
 Parameters for the phase-space sampling.
 
vector< double > weights_
 Weights for the phase-space channels.
 
int channel1_
 Control over channels to check fit fractions.
 
int channel2_
 
long incoming_
 The incoming particle.
 
array< long, 3 > outgoing_
 The outgoing pairtcles.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
 
virtual void doinitrun ()
 Initialize this object.
 
DalitzBaseoperator= (const DalitzBase &)=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.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 
void addResonance (const DalitzResonancePtr &R)
 Add a new resonance.
 
void createMode (tPDPtr in, tPDVector out)
 Set up the phase-space.
 
const vector< DalitzResonancePtr > & resonances () const
 Access to the resonances.
 
const int & channel1 () const
 Access to the first channel.
 
const int & channel2 () const
 Access to the second channel.
 
const InvEnergy & parentRadius () const
 Radius of the parent.
 
const vector< double > & weights () const
 Weights for the phase-space channels.
 

Additional Inherited Members

- Public Types inherited from Herwig::DecayIntegrator
enum  MEOption { Initialize , Calculate , Terminate }
 Enum for the matrix element option. More...
 
- Public Types inherited from Herwig::HwDecayerBase
enum  POWHEGType { No , ISR , FSR , Both }
 Virtual members to be overridden by inheriting classes which implement hard corrections. More...
 
- 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 Herwig::DecayIntegrator
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- Static Public Member Functions inherited from Herwig::HwDecayerBase
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- Static Public Member Functions inherited from ThePEG::Decayer
static void Init ()
 
static ParticleVector DecayParticle (tPPtr parent, Step &step, long maxtry=1000)
 
- 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 Herwig::DecayIntegrator
ParticleVector generate (bool inter, bool cc, const unsigned int &imode, const Particle &inpart) const
 Generate the momenta for the decay.
 
void imode (int in)
 Set the mode being use for this decay.
 
void ME (DecayMEPtr in) const
 Set the helicity matrix element for the decay.
 
DecayMEPtr ME () const
 The helicity amplitude matrix element for spin correlations.
 
void resetIntermediate (tcPDPtr part, Energy mass, Energy width)
 Reset the properities of all intermediates.
 
Energy initializePhaseSpaceMode (unsigned int imode, bool init, bool onShell=false) const
 Initialize the phase-space mode.
 
void generateIntermediates (bool in)
 Methods to set variables in inheriting classes.
 
bool generateIntermediates () const
 Set whether or not the intermediates are included.
 
void hasOneLoopME (bool in)
 Whether or not the one loop matrix element is implemented.
 
void hasRealEmissionME (bool in)
 Whether or not the real emission matrix element is implemented.
 
void epsilonPS (Energy in)
 Set the epsilon parameter.
 
void clearModes ()
 Clear the models.
 
unsigned int numberModes () const
 Number of decay modes.
 
tPhaseSpaceModePtr mode (unsigned int ix)
 Pointer to a mode.
 
tcPhaseSpaceModePtr mode (unsigned int ix) const
 Pointer to a mode.
 
- Protected Member Functions inherited from Herwig::HwDecayerBase
virtual void dofinish ()
 Finalize this object.
 
void fixRho (RhoDMatrix &) const
 Set rho to be diagonal if no correlations.
 
- 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

The DalitzBase class provides a base class for the implementation of three-body Dalitz decays.

See also
The interfaces defined for DalitzBase.

Definition at line 22 of file DalitzBase.h.

Constructor & Destructor Documentation

◆ DalitzBase()

Herwig::DalitzBase::DalitzBase ( )
inline

The default constructor.

Definition at line 29 of file DalitzBase.h.

Member Function Documentation

◆ addResonance()

void Herwig::DalitzBase::addResonance ( const DalitzResonancePtr &  R)
inlineprotected

Add a new resonance.

Definition at line 93 of file DalitzBase.h.

References resonances_.

◆ channel1()

const int & Herwig::DalitzBase::channel1 ( ) const
inlineprotected

Access to the first channel.

Definition at line 108 of file DalitzBase.h.

References channel1_.

Referenced by Herwig::ScalarTo3ScalarDalitz::amplitude(), and Herwig::VectorTo3PseudoScalarDalitz::amplitude().

◆ channel2()

const int & Herwig::DalitzBase::channel2 ( ) const
inlineprotected

Access to the second channel.

Definition at line 115 of file DalitzBase.h.

Referenced by Herwig::ScalarTo3ScalarDalitz::amplitude(), and Herwig::VectorTo3PseudoScalarDalitz::amplitude().

◆ dataBaseOutput()

virtual void Herwig::DalitzBase::dataBaseOutput ( ofstream &  os,
bool  header 
) const
virtual

Output the setup information for the particle database.

Parameters
osThe stream to output the information to
headerWhether or not to output the information for MySQL

Reimplemented from Herwig::DecayIntegrator.

Reimplemented in Herwig::ScalarTo3ScalarDalitz, and Herwig::VectorTo3PseudoScalarDalitz.

◆ doinit()

virtual void Herwig::DalitzBase::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::InterfacedBase.

◆ doinitrun()

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

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from Herwig::DecayIntegrator.

◆ Init()

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

◆ modeNumber()

virtual int Herwig::DalitzBase::modeNumber ( bool &  cc,
tcPDPtr  parent,
const tPDVector children 
) const
virtual

Which of the possible decays is required.

Parameters
ccIs this mode the charge conjugate
parentThe decaying particle
childrenThe decay products

Implements Herwig::DecayIntegrator.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ parentRadius()

const InvEnergy & Herwig::DalitzBase::parentRadius ( ) const
inlineprotected

Radius of the parent.

Definition at line 122 of file DalitzBase.h.

References rParent_.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ resonances()

const vector< DalitzResonancePtr > & Herwig::DalitzBase::resonances ( ) const
inlineprotected

Access to the resonances.

Definition at line 103 of file DalitzBase.h.

References resonances_.

Referenced by Herwig::ScalarTo3ScalarDalitz::amplitude(), and Herwig::VectorTo3PseudoScalarDalitz::amplitude().

◆ weights()

const vector< double > & Herwig::DalitzBase::weights ( ) const
inlineprotected

Weights for the phase-space channels.

Definition at line 129 of file DalitzBase.h.

References weights_.

Member Data Documentation

◆ channel1_

int Herwig::DalitzBase::channel1_
private

Control over channels to check fit fractions.

Definition at line 203 of file DalitzBase.h.

Referenced by channel1().

◆ channel2_

int Herwig::DalitzBase::channel2_
private

Definition at line 203 of file DalitzBase.h.

◆ incoming_

long Herwig::DalitzBase::incoming_
private

The incoming particle.

Definition at line 208 of file DalitzBase.h.

◆ kMatrix_

vector<KMatrixPtr> Herwig::DalitzBase::kMatrix_
private

Any \(K\)-matrices for the decay.

Definition at line 182 of file DalitzBase.h.

◆ maxWgt_

double Herwig::DalitzBase::maxWgt_
private

Parameters for the phase-space sampling.

Maximum weight for the decay

Definition at line 191 of file DalitzBase.h.

◆ outgoing_

array<long,3> Herwig::DalitzBase::outgoing_
private

The outgoing pairtcles.

Definition at line 213 of file DalitzBase.h.

◆ resonances_

vector<DalitzResonancePtr> Herwig::DalitzBase::resonances_
private

Vector containing the intermediate resonances.

Definition at line 177 of file DalitzBase.h.

Referenced by addResonance(), and resonances().

◆ rParent_

InvEnergy Herwig::DalitzBase::rParent_
private

The radii for the Blatt-Weisskopf form factors.

For the decaying particles

Definition at line 166 of file DalitzBase.h.

Referenced by parentRadius().

◆ useAllK0_

bool Herwig::DalitzBase::useAllK0_
private

Take all \(K_0\) mesnos to be the same.

Definition at line 172 of file DalitzBase.h.

◆ weights_

vector<double> Herwig::DalitzBase::weights_
private

Weights for the phase-space channels.

Definition at line 196 of file DalitzBase.h.

Referenced by weights().


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