This code is used to get an Epos4 Monte Carlo event. More...

#include <Epos4.h>

Inheritance diagram for Epos4:

Collaboration diagram for Epos4:

Public Member Functions
	Epos4 (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~Epos4 ()=default
virtual StatusCode	genInitialize () override
	For initializing the generator, if required.
virtual StatusCode	callGenerator () override
	For calling the generator on each iteration of the event loop.
virtual StatusCode	genFinalize () override
	For finalising the generator, if required.
virtual StatusCode	fillEvt (HepMC::GenEvent *evt) override
	For filling the HepMC event object.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded
virtual StatusCode	genuserInitialize ()
	For initialization of user code, if required. Called after genInitialize.
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection).
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const () const
	Access the current signal event (const).
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const).
const McEventCollection *	events_const (const EventContext &ctx) const
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

Protected Member Functions
std::string	create_file (const std::string &filein)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::string	m_inputcard {}
int	m_events {0}
double	m_beamMomentum {0}
double	m_targetMomentum {0}
int	m_argsRandomSeed {0}
IntegerProperty	m_dsid {this, "Dsid", 999999}
std::vector< long int >	m_seeds {111111111,222222222}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Features for derived classes to use internally
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine.
BooleanProperty	m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}
	Flag for normal vs. afterburner generators.
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, const EventContext &ctx) const
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, unsigned long int randomSeedOffset, const EventContext &ctx) const
CLHEP::HepRandomEngine *	getRandomEngineDuringInitialize (const std::string &streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun=1, unsigned int lbn=1) const
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members.
ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service.

Properties
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT).
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.

Detailed Description

This code is used to get an Epos4 Monte Carlo event.

Author: Andrii Verbytskyi

Definition at line 19 of file Epos4.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ Epos4()

Epos4::Epos4	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 108 of file Epos4.cxx.

    : GenModule(name, pSvcLocator) {
 
  epos_rndm_stream = "EPOS4_INIT";
  declareProperty("BeamMomentum", m_beamMomentum = -6500.0); // GeV
  declareProperty("TargetMomentum", m_targetMomentum = 6500.0);
  declareProperty("InputCard", m_inputcard = "foo.optns");
  declareProperty("ArgsRandomSeed", m_argsRandomSeed = 0);
  m_events = 0; // current event number (counted by interface)
}

◆ ~Epos4()

virtual Epos4::~Epos4 ( )

virtualdefault

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection).

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

◆ callGenerator()

StatusCode Epos4::callGenerator ( )

overridevirtual

For calling the generator on each iteration of the event loop.

Reimplemented from GenModule.

Definition at line 306 of file Epos4.cxx.

                                {
  // Re-seed the random number stream
  long seeds[7];
  const EventContext &ctx = Gaudi::Hive::currentContext();
  ATHRNG::calculateSeedsMC21(seeds, epos_rndm_stream,
                             ctx.eventID().event_number(), m_dsid,
                             m_randomSeed);
  p_rndmEngine->setSeeds(seeds, 0); // NOT THREAD-SAFE
  // save the random number seeds in the event
  const long *s = p_rndmEngine->getSeeds();
  m_seeds.assign({s[0], s[1]});
  ++m_events;
  generateEposEvent(m_events);
  listParticles(m_events);
  //    auto e =
  //    std::dynamic_pointer_cast<HepMC3::WriterEPOS>(writer)->current_event();
  return StatusCode::SUCCESS;
}

◆ create_file()

std::string Epos4::create_file ( const std::string & filein )

protected

Definition at line 120 of file Epos4.cxx.

                                                    {
 
  if (filein.size() < 6 ||
      filein.compare(filein.size() - 6, 6, ".optns") != 0) {
    ATH_MSG_ERROR(" Input file name: " << filein
                                       << " does not end with \".optns\"\n");
    return "";
  }
 
  fs::path source = filein;
  fs::path destination =
      fs::current_path() /
      fs::path(std::string("z-") + source.filename().string());
 
  std::ifstream src(source);      // Open in text mode
  std::ofstream dst(destination); // Open in text mode
 
  if (!src) {
    ATH_MSG_ERROR(" Cannot open source file: " << source << "\n");
    return "";
  }
 
  if (!dst) {
    ATH_MSG_ERROR(" Cannot create destination file: " << destination << "\n");
    return "";
  }
 
  std::string line;
  while (std::getline(src, line)) {
    dst << line << '\n';
  }
  dst << "set ihepmc 1" << '\n';
 
  std::string file = source.filename().string().size() > 6
                         ? source.filename().string().substr(
                               0, source.filename().string().size() - 6)
                         : "";
 
  std::string num = "0";
  std::string one = file;
  if (num != "0") {
    one = file + "-" + num;
  }
 
  std::string clinput = "z-" + one + ".clinput";
  std::ofstream ofile(clinput);
 
  std::string CHK = std::getenv("CHK")
                        ? std::getenv("CHK")
                        : (ATH_MSG_WARNING(" CHK not set\n"), "");
  if (m_seeds.size() < 2)
    ATH_MSG_WARNING(" m_seeds should contain at least 2 elements\n");
  std::string seedj;
  if (m_argsRandomSeed != 0) {
    seedj = std::to_string(m_argsRandomSeed);
  } else if (!m_seeds.empty()) {
    seedj = std::to_string(m_seeds.at(0));
  } else {
    seedj = "111111111";
  };
  std::string seedi = m_seeds.size() < 2
                          ? "222222222"
                          : std::to_string(m_seeds.at(
                                1)); // Should be something like "111111111";
                                     // for initialisation only
 
  std::string rootcproot = "nono";
  std::string system = "i";
  std::string ext1 = "-";
  std::string ext3 = "-";
  std::string ext4 = "-";
  std::string gefac = "1";
  auto safeGetenv = [this](const char *envName) -> std::string {
    const char *env = std::getenv(envName);
    if (env)
      return env;
    ATH_MSG_WARNING(envName << " not set.");
    return {};
  };
  std::string EPO = safeGetenv("EPO");
  std::string SRCEXT = safeGetenv("SRCEXT");
  std::string HTO = safeGetenv("HTO");
  std::string SRC = safeGetenv("SRC");
  std::string CONF = safeGetenv("CONF");
  std::string OPT = safeGetenv("OPT");
  std::string OPX = "";
  if (std::string(OPT) == "./") {
    OPX = std::filesystem::current_path().string() + "/";
  } else {
    OPX = std::move(OPT);
  }
 
  ofile << "!fname mtr " << CHK << "z-" << one << ".mtr\n";
  ofile << "set seedj " << seedj << "  set seedi " << seedi << "\n";
  ofile << "echo off\n";
  ofile << "rootcproot " << rootcproot << "\n";
  ofile << "system " << system << "\n";
  ofile << "ext1 " << ext1 << "\n";
  ofile << "ext3 " << ext3 << "\n";
  ofile << "ext4 " << ext4 << "\n";
  ofile << "set gefac " << gefac << "\n";
  ofile << "!!!beginoptns spherio !No longer used.\n";
  ofile << "!!!...                !See version < 3118  \n";
  ofile << "!!!endoptns spherio   !if needed again         \n";
  ofile << "fname pathep " << EPO << "\n";
  ofile << "!-------HQ--------\n";
  ofile << "fname user1  " << SRCEXT << "/HQt/\n";
  ofile << "fname user2  " << HTO << "z-" << one << ".hq\n";
  ofile << "fname user3  " << SRCEXT << "/URt/\n";
  ofile << "!-------HQ END--------\n";
  ofile << "fname pathpdf " << SRC << "/TPt/\n";
  ofile << "fname histo  " << HTO << "z-" << one << ".histo\n";
  ofile << "fname check  " << CHK << "z-" << one << ".check\n";
  ofile << "fname copy   " << CHK << "z-" << one << ".copy\n";
  ofile << "fname log    " << CHK << "z-" << one << ".log\n";
  ofile << "fname data   " << CHK << "z-" << one << ".data\n";
  ofile << "fname initl  " << SRC << "/KWt/aa.i\n";
  ofile << "fname inidi  " << SRC << "/TPt/di.i\n";
  ofile << "fname inidr  " << SRC << "/KWt/dr.i\n";
  ofile << "fname iniev  " << SRC << "/KWt/ev.i\n";
  ofile << "fname inirj  " << SRC << "/KWt/rj.i\n";
  ofile << "fname inics  " << SRC << "/TPt/cs.i\n";
  ofile << "fname inigrv " << SRC << "/grv.i\n";
  ofile << "fname partab " << SRCEXT << "/YK/ptl6.data\n";
  ofile << "fname dectab " << SRCEXT << "/YK/dky6.data\n";
  ofile << "fname hpf    " << SRCEXT << "/UR/tables.dat \n";
  ofile << "!fqgsjet dat   " << EPO << SRC
        << "qgsjet/qgsjet.dat !No longer used.\n";
  ofile << "!fqgsjet ncs   " << EPO << SRC
        << "qgsjet/qgsjet.ncs !No longer used.\n";
  ofile << "!fqgsjetII dat   " << EPO << SRC
        << "qgsjetII/qgsdat-II-03 !No longer used.\n";
  ofile << "!fqgsjetII ncs   " << EPO << SRC
        << "qgsjetII/sectnu-II-03 !No longer used.\n";
  ofile << "nodecay 1220\n";
  ofile << "nodecay -1220\n";
  ofile << "nodecay 120\n";
  ofile << "nodecay -120\n";
  ofile << "nodecay 130\n";
  ofile << "nodecay -130\n";
  ofile << "nodecay -20\n";
  ofile << "nodecay 14\n";
  ofile << "nodecay -14\n";
  ofile << "nodecay 16\n";
  ofile << "nodecay -16\n";
  ofile << "echo on\n";
  ofile << "input " << CONF << "/parbf.i\n";
  ofile << "input " << OPX << "z-" << one << ".optns\n";
  ofile << "input " << SRC << "/KWn/paraf.i\n";
  ofile << "input " << CONF << "/partx.i\n";
  ofile << "runprogram\n";
  ofile << "stopprogram\n";
 
  ofile.close();
  return clinput;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ event_const()

const HepMC::GenEvent * GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const).

Definition at line 83 of file GenBase.h.

                                           {
    if (events_const()->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(events_const()->begin());
  }

◆ events_const() [1/2]

const McEventCollection * GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const).

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

◆ events_const() [2/2]

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Definition at line 99 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode GenModule::execute ( )

virtualinherited

Todo: Remove hard-coded alg name checking (already incomplete)

Reimplemented from GenBase.

Definition at line 70 of file GenModule.cxx.

                              {
  // Examples of how to retrieve the random number engine for a given
  // stream.
  // NB getRandomEngine should only be called once per event for a
  // given stream, as it causes the stream to be re-seeded each time
  // it is called.
 
  // Example 1 - seeded based on the current event number (+ slot, run, streamName)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
 
  // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", m_randomSeed.value(), ctx);
 
  // Call the code that generates an event
  CHECK(this->callGenerator());
 
  // Create the MC event and send the GeneratorEvent stored in it to fillEvt
  HepMC::GenEvent* evt = HepMC::newGenEvent(1,1);
  CHECK(this->fillEvt(evt));
  HepMC::fillBarcodesAttribute(evt);
 
  // Add the event to the MC event collection
  if (events()) {
    // If this is an "afterburner" generator, replace the last event rather than add a new one
    if (m_isAfterburner.value() || name() == "Tauola" || name() == "Photos") {
      events()->pop_back();
    }
    // Add the event to the end of the collection
    events()->push_back(evt);
    ATH_MSG_DEBUG("MC event added to McEventCollection");
 
    // remove the empty event in case of ParticleDecayer
    if (name() == "ParticleDecayer") {
      events()->pop_back();
    }
  }
 
  // Call the incident service to notify that an event has been made
  m_incidentSvc->fireIncident( Incident(name(), "McEventGenerated") );
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ fillEvt()

StatusCode Epos4::fillEvt ( HepMC::GenEvent * evt )

overridevirtual

For filling the HepMC event object.

Here we should put e into evt

Implements GenModule.

Definition at line 339 of file Epos4.cxx.

                                            {
  auto e =
      std::dynamic_pointer_cast<HepMC3::WriterEPOS>(writer)->current_event();
 
  e.set_units(HepMC3::Units::MEV, HepMC3::Units::MM);
  HepMC3::Print::content(e);
 
  *evt = e;
  return StatusCode::SUCCESS;
}

◆ finalize()

StatusCode GenModule::finalize ( )

inlineinherited

Definition at line 55 of file GenModule.h.

55{ return genFinalize(); }

GenModule::genFinalize

virtual StatusCode genFinalize()

For finalising the generator, if required.

Definition GenModule.h:70

◆ genFinalize()

StatusCode Epos4::genFinalize ( )

overridevirtual

For finalising the generator, if required.

Reimplemented from GenModule.

Definition at line 326 of file Epos4.cxx.

                              {
  ATH_MSG_INFO("EPOS4 finalizing.");
  ATH_MSG_INFO("MetaData: generator = Epos4 .");
  writeStatistics();
  finalizeSimulation();
  rewindInputFile();
  readInputFile();
  eposEnd();
  showMemoryAtEnd();
  return StatusCode::SUCCESS;
}

◆ genInitialize()

StatusCode Epos4::genInitialize ( )

overridevirtual

For initializing the generator, if required.

This value should be 1!

Reimplemented from GenModule.

Definition at line 278 of file Epos4.cxx.

                                {
  p_rndmEngine = getRandomEngineDuringInitialize(epos_rndm_stream, m_randomSeed,
                                                 m_dsid); // NOT THREAD-SAFE
  epos_rndm_stream = "EPOS4";
  m_events = 0;
 
  writer = std::make_shared<HepMC3::WriterEPOS>("foo");
  const std::string &x = this->create_file(m_inputcard);
  set_job_common(x.c_str());
  showMemoryAtStart();
  checkTime();
  eposStart();
  readInputFile();
  initializeHeavyQuarkPart();
  initializeElectronProtonPart();
  int currentnumberOfEnergyValues = numberOfEnergyValues();
  for (int k = 1; k <= currentnumberOfEnergyValues; k++) {
    setEnergyIndex(k);
    initializeEpos();
    initializeEventCounters();
    defineStorageSettings();
  }
 
  return StatusCode::SUCCESS;
}

◆ genuserInitialize()

virtual StatusCode GenModule::genuserInitialize ( )

inlinevirtualinherited

For initialization of user code, if required. Called after genInitialize.

Reimplemented in Pythia8B_i.

Definition at line 64 of file GenModule.h.

64{ return StatusCode::SUCCESS; }

◆ getRandomEngine() [1/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine	(	const std::string &	streamName,
		const EventContext &	ctx ) const

protectedinherited

Definition at line 34 of file GenModule.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  std::string rngName = name()+streamName;
  rngWrapper->setSeed( rngName, ctx );
  return rngWrapper->getEngine(ctx);
}

◆ getRandomEngine() [2/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		const EventContext &	ctx ) const

protectedinherited

Definition at line 44 of file GenModule.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  rngWrapper->setSeed( streamName, ctx.slot(), randomSeedOffset, ctx.eventID().run_number() );
  return rngWrapper->getEngine(ctx);
}

◆ getRandomEngineDuringInitialize()

CLHEP::HepRandomEngine * GenModule::getRandomEngineDuringInitialize	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		unsigned int	conditionsRun = 1,
		unsigned int	lbn = 1 ) const

protectedinherited

Definition at line 53 of file GenModule.cxx.

{
  const size_t slot=0;
  EventContext ctx;
  ctx.setSlot( slot );
  ctx.setEventID (EventIDBase (conditionsRun,
               EventIDBase::UNDEFEVT,  // event
               EventIDBase::UNDEFNUM,  // timestamp
               EventIDBase::UNDEFNUM,  // timestamp ns
               lbn));
  Atlas::setExtendedEventContext(ctx,
                                 Atlas::ExtendedEventContext( evtStore()->hiveProxyDict(),
                                                              conditionsRun) );
  return getRandomEngine(streamName, randomSeedOffset, ctx);
}

◆ initialize()

StatusCode GenModule::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 21 of file GenModule.cxx.

                                 {
  // Base class initializations
  CHECK(GenBase::initialize());
  // Get the random number service
  CHECK(m_rndmSvc.retrieve());
  // Get the incident service
  CHECK(m_incidentSvc.retrieve());
  CHECK(genInitialize());
  CHECK(genuserInitialize());
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid ) const

inlineinherited

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                        {
    return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
  }

◆ particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                       {
    return *(m_ppSvc->PDT());
  }

◆ partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                        {
    return m_ppSvc;
  }

◆ pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

123{ return particleTable(); }

GenBase::particleTable

const HepPDT::ParticleDataTable & particleTable() const

Get a particle data table.

Definition GenBase.h:118

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_argsRandomSeed

int Epos4::m_argsRandomSeed {0}

protected

Definition at line 43 of file Epos4.h.

43{0};

◆ m_beamMomentum

double Epos4::m_beamMomentum {0}

protected

Definition at line 39 of file Epos4.h.

39{0};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_dsid

IntegerProperty Epos4::m_dsid {this, "Dsid", 999999}

protected

Definition at line 46 of file Epos4.h.

46{this, "Dsid", 999999};

◆ m_events

int Epos4::m_events {0}

protected

Definition at line 36 of file Epos4.h.

36{0};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_incidentSvc

ServiceHandle<IIncidentSvc> GenModule::m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}

privateinherited

Handle on the incident service.

Definition at line 101 of file GenModule.h.

101{this, "IncidentSvc", "IncidentSvc"};

◆ m_inputcard

std::string Epos4::m_inputcard {}

protected

Definition at line 33 of file Epos4.h.

33{};

◆ m_isAfterburner

BooleanProperty GenModule::m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}

protectedinherited

Flag for normal vs. afterburner generators.

Definition at line 87 of file GenModule.h.

87{this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"};

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT).

Definition at line 136 of file GenBase.h.

136{};

◆ m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 147 of file GenBase.h.

147{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

◆ m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 138 of file GenBase.h.

138{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

◆ m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

privateinherited

Handle on the particle property service.

Definition at line 144 of file GenBase.h.

144{this, "PartPropSvc", "PartPropSvc"};

◆ m_randomSeed

IntegerProperty GenModule::m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}

protectedinherited

Seed for random number engine.

Definition at line 84 of file GenModule.h.

84{this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}; // FIXME make this into an unsigned long int?

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> GenModule::m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}

privateinherited

Data members.

Definition at line 99 of file GenModule.h.

99{this, "RndmSvc", "AthRNGSvc"};

◆ m_seeds

std::vector<long int> Epos4::m_seeds {111111111,222222222}

protected

Definition at line 48 of file Epos4.h.

48{111111111,222222222};

◆ m_targetMomentum

double Epos4::m_targetMomentum {0}

protected

Definition at line 40 of file Epos4.h.

40{0};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Features for derived classes to use internally

Properties

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ Epos4()

◆ ~Epos4()

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

◆ callGenerator()

◆ create_file()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ event_const()

◆ events_const() [1/2]

◆ events_const() [2/2]

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillEvt()

◆ finalize()

◆ genFinalize()

◆ genInitialize()

◆ genuserInitialize()

◆ getRandomEngine() [1/2]

◆ getRandomEngine() [2/2]

◆ getRandomEngineDuringInitialize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ particleData()

◆ particleTable()

◆ partPropSvc()

◆ pdt()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_argsRandomSeed

◆ m_beamMomentum

◆ m_detStore

◆ m_dsid

◆ m_events

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_incidentSvc

◆ m_inputcard

◆ m_isAfterburner

◆ m_mcEventKey

◆ m_mcevents_const

◆ m_mkMcEvent

◆ m_ppSvc

◆ m_randomSeed

◆ m_rndmSvc

◆ m_seeds

◆ m_targetMomentum

◆ m_varHandleArraysDeclared

◆ m_vhka