thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::OneCutBase Class Referenceabstract

This class corresponds to a kinematical cut to be made on a single outgoing parton from a hard sub-process. More...

#include <OneCutBase.h>

Inheritance diagram for ThePEG::OneCutBase:

Public Member Functions

virtual void describe () const
 Describe the currently active cuts in the log file.
 
Standard constructors and destructors.
 OneCutBase ()
 The default constructor.
 
virtual ~OneCutBase ()
 The destructor.
 
Virtual functions to be overridden by sub-classes.
virtual Energy minKT (tcPDPtr p) const =0
 Return the minimum allowed value of the transverse momentum of an outgoing parton.
 
virtual double minEta (tcPDPtr p) const =0
 Return the minimum allowed pseudo-rapidity of an outgoing parton of the given type. More...
 
virtual double maxEta (tcPDPtr p) const =0
 Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type. More...
 
virtual double minRapidityMax (tcPDPtr p) const
 Return the minimum allowed rapidity of an outgoing parton of the given type. More...
 
virtual double maxRapidityMin (tcPDPtr p) const
 Return the maximum allowed rapidity of an outgoing parton of the given type. More...
 
virtual Energy minMaxKT (tcPDPtr p) const
 Return the minimum allowed value of the transverse momentum of the outgoing parton with the lagrest transverse momentum. More...
 
virtual double minMaxEta (tcPDPtr p) const
 Return the minimum allowed pseudo-rapidity of the outgoing parton of the given type with the maximum pseudo-rapidity. More...
 
virtual double maxMinEta (tcPDPtr p) const
 Return the maximum allowed pseudo-rapidity of the outgoing parton of the given type with the minimum pseudo-rapidity. More...
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr ptype, LorentzMomentum p) const
 Return true if a particle with type ptype and momentum p passes the cuts. More...
 
bool passCuts (tcCutsPtr parent, tcPPtr p) const
 Return true if the given particle passes the cuts. More...
 
- 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 IBPtr fullclone () const
 Return a full clone of this object possibly doing things to the clone to make it sane.
 
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.
 
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). More...
 
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::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...
 

Private Member Functions

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

Static Private Attributes

static AbstractNoPIOClassDescription< OneCutBaseinitOneCutBase
 The static object used to initialize the description of this class. More...
 

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.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. 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
virtual IBPtr clone () const =0
 Return a simple clone of this object. More...
 
 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 doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. 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.
 
- 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

This class corresponds to a kinematical cut to be made on a single outgoing parton from a hard sub-process.

There are four main virtual functions which must be overridden by concrete sub-classes. minKT() should return the minimum allowed transverse momentum of a given type, while minEta() and maxEta() should return the minimum and maximum allowed pseudo-rapidity for a particle of a given type as measured in the lab-system. Note that when applied in the rest frame of a hard sub-process, the transformation from the lab frame is assumed to be a simple boost along the z-axis. In addition the passCut() function should return true if a particle with a given type and given momentum will pass the cuts.

See also
The interfaces defined for OneCutBase.

Definition at line 39 of file OneCutBase.h.

Member Function Documentation

◆ Init()

static void ThePEG::OneCutBase::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 OneCutBase().

◆ maxEta()

virtual double ThePEG::OneCutBase::maxEta ( tcPDPtr  p) const
pure virtual

Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type.

The pseudo-rapidity is measured in the lab system.

Implemented in ThePEG::MadGraphOneCut, ThePEG::SimpleKTCut, and ThePEG::KTRapidityCut.

Referenced by OneCutBase().

◆ maxMinEta()

virtual double ThePEG::OneCutBase::maxMinEta ( tcPDPtr  p) const
virtual

Return the maximum allowed pseudo-rapidity of the outgoing parton of the given type with the minimum pseudo-rapidity.

. The pseudo-rapidity is measured in the lab system. This version simply returns maxEta().

Referenced by OneCutBase().

◆ maxRapidityMin()

virtual double ThePEG::OneCutBase::maxRapidityMin ( tcPDPtr  p) const
virtual

Return the maximum allowed rapidity of an outgoing parton of the given type.

The rapidity is measured in the lab system.

Reimplemented in ThePEG::KTRapidityCut.

Referenced by OneCutBase().

◆ minEta()

virtual double ThePEG::OneCutBase::minEta ( tcPDPtr  p) const
pure virtual

Return the minimum allowed pseudo-rapidity of an outgoing parton of the given type.

The pseudo-rapidity is measured in the lab system.

Implemented in ThePEG::MadGraphOneCut, ThePEG::SimpleKTCut, and ThePEG::KTRapidityCut.

Referenced by OneCutBase().

◆ minMaxEta()

virtual double ThePEG::OneCutBase::minMaxEta ( tcPDPtr  p) const
virtual

Return the minimum allowed pseudo-rapidity of the outgoing parton of the given type with the maximum pseudo-rapidity.

The pseudo-rapidity is measured in the lab system. This version simply returns minEta().

Referenced by OneCutBase().

◆ minMaxKT()

virtual Energy ThePEG::OneCutBase::minMaxKT ( tcPDPtr  p) const
virtual

Return the minimum allowed value of the transverse momentum of the outgoing parton with the lagrest transverse momentum.

This version simply returns minKt().

Reimplemented in ThePEG::MadGraphOneCut.

Referenced by OneCutBase().

◆ minRapidityMax()

virtual double ThePEG::OneCutBase::minRapidityMax ( tcPDPtr  p) const
virtual

Return the minimum allowed rapidity of an outgoing parton of the given type.

The rapidity is measured in the lab system.

Reimplemented in ThePEG::KTRapidityCut.

Referenced by OneCutBase().

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts() [1/2]

virtual bool ThePEG::OneCutBase::passCuts ( tcCutsPtr  parent,
tcPDPtr  ptype,
LorentzMomentum  p 
) const
virtual

Return true if a particle with type ptype and momentum p passes the cuts.

The parent contains information about the kinematics of the hard sub-process.

Reimplemented in ThePEG::MadGraphOneCut, ThePEG::SimpleKTCut, and ThePEG::KTRapidityCut.

Referenced by OneCutBase().

◆ passCuts() [2/2]

bool ThePEG::OneCutBase::passCuts ( tcCutsPtr  parent,
tcPPtr  p 
) const

Return true if the given particle passes the cuts.

The parent contains information about the kinematics of the hard sub-process.

Member Data Documentation

◆ initOneCutBase

AbstractNoPIOClassDescription<OneCutBase> ThePEG::OneCutBase::initOneCutBase
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 154 of file OneCutBase.h.


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