thepeg is hosted by Hepforge, IPPP Durham
ThePEG 2.3.0
ThePEG::AlphaSBase Class Referenceabstract

AlphaSBase is an abstract base class used by the StandardModelBase to implement the QCD coupling, \(\alpha_S\). More...

#include <AlphaSBase.h>

Inheritance diagram for ThePEG::AlphaSBase:

Public Member Functions

Virtual functions to be overridden by sub-classes.
virtual vector< Energy2flavourThresholds () const =0
 Return the flavour thresholds used.
 
virtual vector< EnergyLambdaQCDs () const =0
 Return the \(\Lambda_{QCD}\) used for different numbers of active flavours.
 
Access information about number of flavours and

\(\Lambda_{QCD}\).

unsigned int Nf (Energy2 scale) const
 Return the number of avtive quark flavours.
 
Energy LambdaQCD (unsigned int nflav) const
 Return the \(\Lambda_{QCD}\) used for nflav active flavours.
 
Energy LambdaQCD (Energy2 scale) const
 Return the \(\Lambda_{QCD}\) used for corresponding given scale.
 
const vector< Energy > & quarkMasses () const
 Return the quark masses to be used; if not empty these masses should be considered instead of the ones set in the particle data objects.
 
- Public Member Functions inherited from ThePEG::RunningCoupling
 RunningCoupling ()
 The default constructor.
 
virtual double value (Energy2 scale, const StandardModelBase &sm) const =0
 Return the value of the coupling at a given scale using the given standard model object, sm.
 
virtual unsigned int nloops () const
 Return the number of loops contributing to the running this coupling.
 
double value (Energy2 scale) const
 Return the value of the coupling at a given scale using the StandardModelBase object used by the EventGenerator.
 
virtual double overestimateValue (Energy2 scale) const
 Return an overestimate to the running coupling at the given scale.
 
virtual double ratioToOverestimate (Energy2) const
 Return the ratio of the exact to the overestimated value of the running coupling.
 
double scaleFactor () const
 Return the scale factor, which may be used to globally rescale the argument of the running coupling.
 
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::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.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).
 
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.
 

Standard Interfaced functions.

vector< EnergytheQuarkMasses
 The quark masses to be used; if not empty these masses should be considered instead of the ones set in the particle data objects.
 
vector< Energy2theFlavourThresholds
 Flavour thresholds, set from the virtual functions in the initialization.
 
vector< EnergytheLambdaQCDs
 The values of \(\Lambda_{QCD}\) corresponding to theFlavourThresholds, set from the virtual functions in the initialization.
 
static AbstractClassDescription< AlphaSBaseinitAlphaSBase
 Describe an abstract class with persistent data.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
 
AlphaSBaseoperator= (const AlphaSBase &)=delete
 Private and non-existent assignment operator.
 

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 ()
 Standard Init function used to initialize the interface.
 

Additional Inherited Members

- 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.
 
- Static Public Member Functions inherited from ThePEG::RunningCoupling
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.
 
- 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.
 
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.
 
- 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.
 

Detailed Description

AlphaSBase is an abstract base class used by the StandardModelBase to implement the QCD coupling, \(\alpha_S\).

The AlphaSBase also encodes the number of active flavours at a given scale and the \(\Lambda_{QCD}\) for a given number of active flavours or for a given scale.

See also
The interfaces defined for AlphaSBase.
StandardModelBase

Definition at line 28 of file AlphaSBase.h.

Member Function Documentation

◆ doinit()

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

◆ flavourThresholds()

virtual vector< Energy2 > ThePEG::AlphaSBase::flavourThresholds ( ) const
pure virtual

Return the flavour thresholds used.

The returned vector contains (in position i) the scales when the active number of flavours changes from i to i+1.

Implemented in ThePEG::O1AlphaS.

◆ LambdaQCD() [1/2]

Energy ThePEG::AlphaSBase::LambdaQCD ( Energy2  scale) const
inline

Return the \(\Lambda_{QCD}\) used for corresponding given scale.

Definition at line 69 of file AlphaSBase.h.

References Nf(), and theLambdaQCDs.

◆ LambdaQCD() [2/2]

Energy ThePEG::AlphaSBase::LambdaQCD ( unsigned int  nflav) const
inline

Return the \(\Lambda_{QCD}\) used for nflav active flavours.

Definition at line 64 of file AlphaSBase.h.

References theLambdaQCDs.

◆ LambdaQCDs()

virtual vector< Energy > ThePEG::AlphaSBase::LambdaQCDs ( ) const
pure virtual

Return the \(\Lambda_{QCD}\) used for different numbers of active flavours.

Implemented in ThePEG::O1AlphaS.

◆ Nf()

unsigned int ThePEG::AlphaSBase::Nf ( Energy2  scale) const
inline

Return the number of avtive quark flavours.

Definition at line 54 of file AlphaSBase.h.

References theFlavourThresholds.

Referenced by LambdaQCD().

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ quarkMasses()

const vector< Energy > & ThePEG::AlphaSBase::quarkMasses ( ) const
inline

Return the quark masses to be used; if not empty these masses should be considered instead of the ones set in the particle data objects.

Definition at line 77 of file AlphaSBase.h.

References theQuarkMasses.

Member Data Documentation

◆ initAlphaSBase

AbstractClassDescription<AlphaSBase> ThePEG::AlphaSBase::initAlphaSBase
staticprivate

Describe an abstract class with persistent data.

Definition at line 143 of file AlphaSBase.h.

◆ theFlavourThresholds

vector<Energy2> ThePEG::AlphaSBase::theFlavourThresholds
private

Flavour thresholds, set from the virtual functions in the initialization.

Definition at line 129 of file AlphaSBase.h.

Referenced by Nf().

◆ theLambdaQCDs

vector<Energy> ThePEG::AlphaSBase::theLambdaQCDs
private

The values of \(\Lambda_{QCD}\) corresponding to theFlavourThresholds, set from the virtual functions in the initialization.

Definition at line 136 of file AlphaSBase.h.

Referenced by LambdaQCD().

◆ theQuarkMasses

vector<Energy> ThePEG::AlphaSBase::theQuarkMasses
private

The quark masses to be used; if not empty these masses should be considered instead of the ones set in the particle data objects.

Definition at line 123 of file AlphaSBase.h.

Referenced by quarkMasses().


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