Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
PythiaGun Class Reference

#include <JETSCAPE/blob/main/src/initialstate/PythiaGun.h>

+ Inheritance diagram for PythiaGun:
+ Collaboration diagram for PythiaGun:

Public Member Functions

 PythiaGun (string xmlDir="DONTUSETHIS", bool printBanner=false)
 
 ~PythiaGun ()
 
void InitTask ()
 
void Exec ()
 
double GetpTHatMin () const
 
double GetpTHatMax () const
 
double GetSigmaGen ()
 
double GetSigmaErr ()
 
double GetPtHat ()
 
double GetEventWeight ()
 
- Public Member Functions inherited from Jetscape::HardProcess
 HardProcess ()
 
virtual ~HardProcess ()
 
virtual void Init ()
 
virtual void Clear ()
 
virtual void WriteTask (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeader (weak_ptr< JetScapeWriter > w)
 
int GetNHardPartons ()
 
shared_ptr< Parton > GetPartonAt (int i)
 
vector< shared_ptr< Parton > > & GetPartonList ()
 
void AddParton (shared_ptr< Parton > p)
 
void GetHardPartonList (vector< shared_ptr< Parton >> &plist)
 
void AddHadron (shared_ptr< Hadron > h)
 
void GetHadronList (vector< shared_ptr< Hadron >> &hlist)
 
vector< shared_ptr< Hadron > > & GetHadronList ()
 
int GetNHadrons ()
 
- Public Member Functions inherited from Jetscape::JetScapeModuleBase
 JetScapeModuleBase ()
 
 JetScapeModuleBase (string m_name)
 
virtual ~JetScapeModuleBase ()
 
void SetXMLMainFileName (string m_name)
 
string GetXMLMainFileName ()
 
void SetXMLUserFileName (string m_name)
 
string GetXMLUserFileName ()
 
shared_ptr< std::mt19937 > GetMt19937Generator ()
 
tinyxml2::XMLElement * GetXMLElement (std::initializer_list< const char * > path, bool isRequired=true)
 
std::string GetXMLElementText (std::initializer_list< const char * > path, bool isRequired=true)
 
int GetXMLElementInt (std::initializer_list< const char * > path, bool isRequired=true)
 
double GetXMLElementDouble (std::initializer_list< const char * > path, bool isRequired=true)
 
- Public Member Functions inherited from Jetscape::JetScapeTask
 JetScapeTask ()
 
virtual ~JetScapeTask ()
 
virtual void Finish ()
 
virtual void ExecuteTasks ()
 
virtual void ExecuteTask ()
 
virtual void InitTasks ()
 
virtual void ClearTasks ()
 
virtual void ClearTask ()
 
virtual void FinishTask ()
 
virtual void FinishTasks ()
 
virtual void WriteTasks (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeaders (weak_ptr< JetScapeWriter > w)
 
virtual void Add (shared_ptr< JetScapeTask > m_tasks)
 
virtual const int GetMyTaskNumber () const
 
const vector< shared_ptr
< JetScapeTask > > 		GetTaskList () const
 
shared_ptr< JetScapeTask > GetTaskAt (int i)
 
void EraseTaskLast ()
 
void EraseTaskAt (int i)
 
void ResizeTaskList (int i)
 
void ClearTaskList ()
 
int GetNumberOfTasks ()
 
const bool GetActive () const
 
void SetActive (bool m_active_exec)
 
void SetId (string m_id)
 
const string GetId () const
 
const shared_ptr
< JetScapeModuleMutex > 		GetMutex () const
 
void SetMutex (shared_ptr< JetScapeModuleMutex > m_mutex)
 
- Public Member Functions inherited from sigslot::has_slots< sigslot::multi_threaded_local >
 has_slots ()
 
 has_slots (const has_slots &hs)
 
void signal_connect (_signal_base< sigslot::multi_threaded_local > *sender)
 
void signal_disconnect (_signal_base< sigslot::multi_threaded_local > *sender)
 
virtual ~has_slots ()
 
void disconnect_all ()
 

Private Attributes

double pTHatMin
 
double pTHatMax
 
double eCM
 
double vir_factor
 
double softMomentumCutoff
 
bool FSR_on
 
bool softQCD
 

Static Private Attributes

static RegisterJetScapeModule
< PythiaGun > 		reg
 

Additional Inherited Members

- Static Public Member Functions inherited from Jetscape::JetScapeModuleBase
static int GetCurrentEvent ()
 
static void IncrementCurrentEvent ()
 
- Public Attributes inherited from Jetscape::HardProcess
std::shared_ptr< InitialState > ini
 
std::string printer
 

Detailed Description

Definition at line 27 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 27 of file PythiaGun.h

Constructor & Destructor Documentation

PythiaGun::PythiaGun ( string  xmlDir = "DONTUSETHIS",
bool  printBanner = false 
)
inline

standard ctor

Parameters
xmlDir,:Note that the environment variable PYTHIA8DATA takes precedence! So don't use it.
printBanner,:Suppress starting blurb. Should be set to true in production, credit where it's due

Definition at line 46 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 46 of file PythiaGun.h

References SetId().

+ Here is the call graph for this function:

PythiaGun::~PythiaGun ( )

Definition at line 29 of file PythiaGun.cc.

View newest version in sPHENIX GitHub at line 29 of file PythiaGun.cc

References VERBOSE.

Member Function Documentation

void PythiaGun::Exec ( )
virtual

Calls JetScapeTask::ExecuteTasks() for recursive execution of tasks attached to HardProcess module. It can be overridden by the attached module.

Reimplemented from Jetscape::HardProcess.

Definition at line 156 of file PythiaGun.cc.

View newest version in sPHENIX GitHub at line 156 of file PythiaGun.cc

References release::app, i, JSWARN, next, out, merge_hashes::p, particle, Jetscape::rounding_error, Acts::Experimental::detail::BlueprintHelper::sort(), VERBOSE, ambiguity_solver_full_chain::x, and y.

+ Here is the call graph for this function:

double PythiaGun::GetEventWeight ( )
inlinevirtual

Generated weight. This is in addition to sigmaGen, e.g. coming from dynamic oversampling. To be overwritten by implementations that have such information.

Reimplemented from Jetscape::HardProcess.

Definition at line 64 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 64 of file PythiaGun.h

double PythiaGun::GetPtHat ( )
inlinevirtual

Generated pt-hat To be overwritten by implementations that have such information.

Reimplemented from Jetscape::HardProcess.

Definition at line 63 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 63 of file PythiaGun.h

double PythiaGun::GetpTHatMax ( ) const
inline

Definition at line 58 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 58 of file PythiaGun.h

double PythiaGun::GetpTHatMin ( ) const
inline

Definition at line 57 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 57 of file PythiaGun.h

double PythiaGun::GetSigmaErr ( )
inlinevirtual

Generated cross section error. To be overwritten by implementations that have such information.

Reimplemented from Jetscape::HardProcess.

Definition at line 62 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 62 of file PythiaGun.h

double PythiaGun::GetSigmaGen ( )
inlinevirtual

Generated cross section. To be overwritten by implementations that have such information.

Reimplemented from Jetscape::HardProcess.

Definition at line 61 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 61 of file PythiaGun.h

void PythiaGun::InitTask ( )
virtual

A virtual function to define a default InitTask() function for a JetScapeTask. It can be overridden by different modules/tasks.

Reimplemented from Jetscape::JetScapeTask.

Definition at line 31 of file PythiaGun.cc.

View newest version in sPHENIX GitHub at line 31 of file PythiaGun.cc

References release::app, tinyxml2::XMLNode::FirstChildElement(), i, in, myAnalysis::init(), JSDEBUG, JSINFO, JSWARN, test_fpe::lines, MAGENTA, out, tinyxml2::XMLElement::QueryUnsignedText(), physmon_simulation::s, seed, SetId(), and VERBOSE.

+ Here is the call graph for this function:

Member Data Documentation

double PythiaGun::eCM
private

Definition at line 32 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 32 of file PythiaGun.h

bool PythiaGun::FSR_on
private

Definition at line 35 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 35 of file PythiaGun.h

double PythiaGun::pTHatMax
private

Definition at line 31 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 31 of file PythiaGun.h

double PythiaGun::pTHatMin
private

Definition at line 30 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 30 of file PythiaGun.h

RegisterJetScapeModule< PythiaGun > PythiaGun::reg
staticprivate

Definition at line 39 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 39 of file PythiaGun.h

double PythiaGun::softMomentumCutoff
private

Definition at line 34 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 34 of file PythiaGun.h

bool PythiaGun::softQCD
private

Definition at line 36 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 36 of file PythiaGun.h

double PythiaGun::vir_factor
private

Definition at line 33 of file PythiaGun.h.

View newest version in sPHENIX GitHub at line 33 of file PythiaGun.h

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