Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NcollListFromFile Class Reference

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

+ Inheritance diagram for NcollListFromFile:
+ Collaboration diagram for NcollListFromFile:

Public Member Functions

 NcollListFromFile ()
 
 ~NcollListFromFile ()
 
void Exec ()
 
void Clear ()
 
double GetNcoll ()
 
void ReadNbcList (std::string filename)
 Load saved number of binary collisions.
 
void SampleABinaryCollisionPoint (double &x, double &y)
 
- Public Member Functions inherited from Jetscape::InitialState
 InitialState ()
 
 ~InitialState ()
 
virtual void Init ()
 
virtual void Write (weak_ptr< JetScapeWriter > w)
 
virtual void CollectHeader (weak_ptr< JetScapeWriter > w)
 
virtual double GetNpart ()
 
virtual double GetTotalEntropy ()
 
void SetRanges (double xmax, double ymax, double zmax)
 
void SetSteps (double dx, double dy, double dz)
 
std::vector< doubleGetEntropyDensityDistribution ()
 
std::vector< doubleGetNumOfBinaryCollisions ()
 
int GetEventId () const
 
void SetEventId (int event_id_in)
 set the event id
 
std::tuple< double, double,
double
CoordFromIdx (int idx)
 
double GetXMax ()
 
double GetXStep ()
 
double GetYMax ()
 
double GetYStep ()
 
double GetZMax ()
 
double GetZStep ()
 
int GetXSize ()
 
int GetYSize ()
 
int GetZSize ()
 
- 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::XMLElementGetXMLElement (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 InitTask ()
 
virtual void InitTasks ()
 
virtual void ClearTasks ()
 
virtual void ClearTask ()
 
virtual void FinishTask ()
 
virtual void FinishTasks ()
 
virtual void WriteTasks (weak_ptr< JetScapeWriter > w)
 
virtual void WriteTask (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< JetScapeTaskGetTaskAt (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

std::vector< doublebinary_collision_x_
 
std::vector< doublebinary_collision_y_
 
std::shared_ptr
< std::uniform_int_distribution
< int > > 
rand_int_ptr_
 
double ncoll_ = -1
 

Static Private Attributes

static RegisterJetScapeModule
< NcollListFromFile
reg
 

Additional Inherited Members

- Static Public Member Functions inherited from Jetscape::JetScapeModuleBase
static int GetCurrentEvent ()
 
static void IncrementCurrentEvent ()
 
- Protected Attributes inherited from Jetscape::InitialState
std::vector< doubleentropy_density_distribution_
 
std::vector< doublenum_of_binary_collisions_
 
int event_id_
 
double grid_max_x_
 
double grid_max_y_
 
double grid_max_z_
 
double grid_step_x_
 
double grid_step_y_
 
double grid_step_z_
 

Detailed Description

Definition at line 30 of file NcollListFromFile.h.

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

Constructor & Destructor Documentation

NcollListFromFile::NcollListFromFile ( )

Definition at line 24 of file NcollListFromFile.cc.

View newest version in sPHENIX GitHub at line 24 of file NcollListFromFile.cc

References Jetscape::InitialState::event_id_, and Jetscape::JetScapeTask::SetId().

+ Here is the call graph for this function:

NcollListFromFile::~NcollListFromFile ( )

Definition at line 29 of file NcollListFromFile.cc.

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

Member Function Documentation

void NcollListFromFile::Clear ( void  )
virtual

Default Clear() function. It can be overridden by other tasks.

Reimplemented from Jetscape::InitialState.

Definition at line 52 of file NcollListFromFile.cc.

View newest version in sPHENIX GitHub at line 52 of file NcollListFromFile.cc

References binary_collision_x_, binary_collision_y_, and JSINFO.

Referenced by Exec().

+ Here is the caller graph for this function:

void NcollListFromFile::Exec ( )
virtual

Default Exec() function. It can be overridden by other tasks.

Reimplemented from Jetscape::InitialState.

Definition at line 31 of file NcollListFromFile.cc.

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

References Clear(), check_license::err(), Jetscape::InitialState::event_id_, Jetscape::JetScapeModuleBase::GetXMLElementText(), JSINFO, JSWARN, and ReadNbcList().

+ Here is the call graph for this function:

double NcollListFromFile::GetNcoll ( )
inlinevirtual

Generated number of binary collisions.

Reimplemented from Jetscape::InitialState.

Definition at line 49 of file NcollListFromFile.h.

View newest version in sPHENIX GitHub at line 49 of file NcollListFromFile.h

void NcollListFromFile::ReadNbcList ( std::string  filename)

Load saved number of binary collisions.

Definition at line 59 of file NcollListFromFile.cc.

View newest version in sPHENIX GitHub at line 59 of file NcollListFromFile.cc

References binary_collision_x_, binary_collision_y_, filename, infile, JSINFO, JSWARN, ncoll_, rand_int_ptr_, ambiguity_solver_full_chain::x, and y.

Referenced by Exec().

+ Here is the caller graph for this function:

void NcollListFromFile::SampleABinaryCollisionPoint ( double x,
double y 
)
virtual

Reimplemented from Jetscape::InitialState.

Definition at line 81 of file NcollListFromFile.cc.

View newest version in sPHENIX GitHub at line 81 of file NcollListFromFile.cc

References binary_collision_x_, binary_collision_y_, and Jetscape::JetScapeModuleBase::GetMt19937Generator().

+ Here is the call graph for this function:

Member Data Documentation

std::vector<double> NcollListFromFile::binary_collision_x_
private

Definition at line 57 of file NcollListFromFile.h.

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

Referenced by Clear(), ReadNbcList(), and SampleABinaryCollisionPoint().

std::vector<double> NcollListFromFile::binary_collision_y_
private

Definition at line 58 of file NcollListFromFile.h.

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

Referenced by Clear(), ReadNbcList(), and SampleABinaryCollisionPoint().

double NcollListFromFile::ncoll_ = -1
private

Definition at line 61 of file NcollListFromFile.h.

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

Referenced by ReadNbcList().

std::shared_ptr<std::uniform_int_distribution<int> > NcollListFromFile::rand_int_ptr_
private

Definition at line 59 of file NcollListFromFile.h.

View newest version in sPHENIX GitHub at line 59 of file NcollListFromFile.h

Referenced by ReadNbcList().

RegisterJetScapeModule< NcollListFromFile > NcollListFromFile::reg
staticprivate

Definition at line 65 of file NcollListFromFile.h.

View newest version in sPHENIX GitHub at line 65 of file NcollListFromFile.h


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