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

IdentifiedParticleCut implements cuts on single momenta. More...

#include <IdentifiedParticleCut.h>

Inheritance diagram for Herwig::IdentifiedParticleCut:

Public Member Functions

 IdentifiedParticleCut ()
 The default constructor.
 
Virtual functions to be overridden by sub-classes.
virtual Energy minKT (tcPDPtr) const
 Return the minimum allowed value of the transverse momentum of an outgoing parton.
 
virtual double minEta (tcPDPtr) const
 Return the minimum allowed pseudo-rapidity of an outgoing parton of the given type.
 
virtual double maxEta (tcPDPtr) const
 Return the maximum allowed pseudo-rapidity of an outgoing parton of the given type.
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr ptype, LorentzMomentum p) const
 Return true if a particle with type ptype and momentum p passes the cuts.
 
virtual void describe () const
 Describe the currently active cuts in the log file.
 
Energy ptMin () const
 Return the minimum pt.
 
Energy ptMax () const
 Return the maximum pt.
 
const vector< pair< double, double > > & yRanges () const
 Return the rapidity ranges.
 
Ptr< MatcherBase >::tptr matcher () const
 Return the matcher for particles to cut on.
 
- Public Member Functions inherited from ThePEG::OneCutBase
virtual Energy minKT (tcPDPtr p) const=0
 
virtual double minEta (tcPDPtr p) const=0
 
virtual double maxEta (tcPDPtr p) const=0
 
virtual double minRapidityMax (tcPDPtr p) const
 
virtual double maxRapidityMin (tcPDPtr p) const
 
virtual Energy minMaxKT (tcPDPtr p) const
 
virtual double minMaxEta (tcPDPtr p) const
 
virtual double maxMinEta (tcPDPtr p) const
 
virtual bool passCuts (tcCutsPtr parent, tcPDPtr ptype, LorentzMomentum p) const
 
bool passCuts (tcCutsPtr parent, tcPPtr p) const
 
virtual void describe () 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
 

Clone Methods.

Energy thePtMin
 The minimum pt.
 
Energy thePtMax
 The maximum pt.
 
vector< pair< double, double > > theYRanges
 The rapidity ranges.
 
Ptr< MatcherBase >::ptr theMatcher
 A matcher for particles to cut on.
 
virtual IBPtr clone () const
 Make a simple clone of this object.
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
 
string doYRange (string)
 Command to insert a rapidity range.
 
IdentifiedParticleCutoperator= (const IdentifiedParticleCut &)=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.
 

Additional Inherited Members

- 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 ThePEG::OneCutBase
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 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

IdentifiedParticleCut implements cuts on single momenta.

Author
Simon Platzer
See also
The interfaces defined for IdentifiedParticleCut.

Definition at line 31 of file IdentifiedParticleCut.h.

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ describe()

virtual void Herwig::IdentifiedParticleCut::describe ( ) const
virtual

Describe the currently active cuts in the log file.

Reimplemented from ThePEG::OneCutBase.

◆ fullclone()

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

◆ Init()

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

◆ matcher()

Ptr< MatcherBase >::tptr Herwig::IdentifiedParticleCut::matcher ( ) const
inline

Return the matcher for particles to cut on.

Definition at line 98 of file IdentifiedParticleCut.h.

References theMatcher.

◆ maxEta()

virtual double Herwig::IdentifiedParticleCut::maxEta ( tcPDPtr  ) const
inlinevirtual

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

The pseudo-rapidity is measured in the lab system.

Implements ThePEG::OneCutBase.

Definition at line 62 of file IdentifiedParticleCut.h.

References ThePEG::Constants::MaxRapidity.

◆ minEta()

virtual double Herwig::IdentifiedParticleCut::minEta ( tcPDPtr  ) const
inlinevirtual

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

The pseudo-rapidity is measured in the lab system.

Implements ThePEG::OneCutBase.

Definition at line 55 of file IdentifiedParticleCut.h.

References ThePEG::Constants::MaxRapidity.

◆ minKT()

virtual Energy Herwig::IdentifiedParticleCut::minKT ( tcPDPtr  ) const
inlinevirtual

Return the minimum allowed value of the transverse momentum of an outgoing parton.

Implements ThePEG::OneCutBase.

Definition at line 48 of file IdentifiedParticleCut.h.

References ThePEG::ZERO.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ passCuts()

virtual bool Herwig::IdentifiedParticleCut::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 from ThePEG::OneCutBase.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ ptMax()

Energy Herwig::IdentifiedParticleCut::ptMax ( ) const
inline

Return the maximum pt.

Definition at line 88 of file IdentifiedParticleCut.h.

References thePtMax.

◆ ptMin()

Energy Herwig::IdentifiedParticleCut::ptMin ( ) const
inline

Return the minimum pt.

Definition at line 83 of file IdentifiedParticleCut.h.

References thePtMin.

◆ yRanges()

const vector< pair< double, double > > & Herwig::IdentifiedParticleCut::yRanges ( ) const
inline

Return the rapidity ranges.

Definition at line 93 of file IdentifiedParticleCut.h.

References theYRanges.

Member Data Documentation

◆ theMatcher

Ptr<MatcherBase>::ptr Herwig::IdentifiedParticleCut::theMatcher
private

A matcher for particles to cut on.

Definition at line 172 of file IdentifiedParticleCut.h.

Referenced by matcher().

◆ thePtMax

Energy Herwig::IdentifiedParticleCut::thePtMax
private

The maximum pt.

Definition at line 162 of file IdentifiedParticleCut.h.

Referenced by ptMax().

◆ thePtMin

Energy Herwig::IdentifiedParticleCut::thePtMin
private

The minimum pt.

Definition at line 157 of file IdentifiedParticleCut.h.

Referenced by ptMin().

◆ theYRanges

vector<pair<double,double> > Herwig::IdentifiedParticleCut::theYRanges
private

The rapidity ranges.

Definition at line 167 of file IdentifiedParticleCut.h.

Referenced by yRanges().


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