herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
Herwig::GravitonMassGenerator Class Reference

Here is the documentation of the GravitonMassGenerator class. More...

#include <GravitonMassGenerator.h>

Inheritance diagram for Herwig::GravitonMassGenerator:

Public Member Functions

 GravitonMassGenerator ()
 The default constructor.
 
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 Herwig::GenericMassGenerator
 GenericMassGenerator ()
 Default constructor.
 
virtual ~GenericMassGenerator ()
 Destructor.
 
bool accept (const ParticleData &part) const
 Return true if this mass generator can handle the given particle type. More...
 
virtual void dataBaseOutput (ofstream &, bool)
 Output the initialisation info for the database.
 
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...
 
Energy mass (const ParticleData &part) const
 Generate a mass using the default limits. More...
 
Energy mass (const ParticleData &part, const Energy low, const Energy upp) const
 Generate a mass using specified limits. More...
 
Energy mass (double &wgt, const ParticleData &part, double r=UseRandom::rnd()) const
 Return a mass with the weight using the default limits. More...
 
Energy mass (double &wgt, const ParticleData &part, const Energy low, const Energy upp, double r=UseRandom::rnd()) const
 Return a mass with the weight using the specified limits. More...
 
virtual double weight (Energy q) const
 Weight for the factor. More...
 
virtual InvEnergy2 BreitWignerWeight (Energy q)
 Return the full weight.
 
pair< Energy, Energy > width (Energy q, int shape) const
 The running width. More...
 
Energy lowerLimit () const
 Lower limit on the mass.
 
Energy upperLimit () const
 Upper limit on the mass.
 
Energy nominalMass () const
 Default mass.
 
Energy nominalWidth () const
 Default Width.
 
- 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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from Herwig::GenericMassGenerator
static void Init ()
 Standard Init function used to initialize the interfaces.
 
- Static Public Member Functions inherited from ThePEG::MassGenerator
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 ()
 

Protected Member Functions

virtual Energy mass (double &wgt, const ParticleData &part, const Energy low, const Energy upp, int shape, double r=UseRandom::rnd()) const
 Return a mass with the weight using the specified limits. More...
 
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...
 
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
- Protected Member Functions inherited from Herwig::GenericMassGenerator
virtual void dofinish ()
 Finalize this object. More...
 
virtual void rebind (const TranslationMap &trans)
 Rebind pointer to other Interfaced objects. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
Energy mass (double &wgt, const ParticleData &part, int shape, double r=UseRandom::rnd()) const
 Return a mass with the weight using the default limits. More...
 
virtual double weight (Energy q, int shape) const
 Weight for the factor. More...
 
virtual InvEnergy2 BreitWignerWeight (Energy q, int shape) const
 Return the full weight.
 
tcPDPtr particle () const
 Accesss to the particle.
 
void particle (tPDPtr in)
 Set the particle.
 
- 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
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const 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)
 

Private Member Functions

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

Private Attributes

double prefactor_
 prefactor
 
unsigned int delta_
 Number of extra dimensions.
 
Energy md_
 d-dimensional Planck mass
 
Energy mMin_
 Minimum mass cut to avoid numerical problems.
 

Static Private Attributes

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

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- 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)
 

Detailed Description

Here is the documentation of the GravitonMassGenerator class.

See also
The interfaces defined for GravitonMassGenerator.

Definition at line 20 of file GravitonMassGenerator.h.

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from Herwig::GenericMassGenerator.

◆ doinit()

virtual void Herwig::GravitonMassGenerator::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::GenericMassGenerator.

◆ fullclone()

virtual IBPtr Herwig::GravitonMassGenerator::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::GenericMassGenerator.

◆ Init()

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

◆ mass()

virtual Energy Herwig::GravitonMassGenerator::mass ( double &  wgt,
const ParticleData part,
const Energy  low,
const Energy  upp,
int  shape,
double  r = UseRandom::rnd() 
) const
protectedvirtual

Return a mass with the weight using the specified limits.

Parameters
partThe particle data pointer of the particle.
lowThe lower limit on the particle's mass.
uppThe upper limit on the particle's mass.
wgtThe weight for this mass.
shapeThe type of shape to use
rThe random number used for the weight
Returns
The mass of the particle instance.

Reimplemented from Herwig::GenericMassGenerator.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Member Data Documentation

◆ initGravitonMassGenerator

ClassDescription<GravitonMassGenerator> Herwig::GravitonMassGenerator::initGravitonMassGenerator
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 106 of file GravitonMassGenerator.h.


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