Herwig7 Class Reference

Interface to athena. More...

#include <Herwig7.h>

Inheritance diagram for Herwig7:

Collaboration diagram for Herwig7:

Public Member Functions
	Herwig7 (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
StatusCode	genInitialize ()
	Initialize the generator.
StatusCode	callGenerator ()
	Run the generator for one event.
StatusCode	fillEvt (HepMC::GenEvent *evt)
	Convert the generated event into the HepMC format.
StatusCode	genFinalize ()
	Close down the generator.
StatusCode	writeRunFileFromText (const std::string &share_path)
	Write the CA input text into a real Herwig runfile.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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 (const EventContext &ctx)
	Execute method.
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 EventContext &ctx) const
	Access the current signal event (const).
const McEventCollection *	events_const (const EventContext &ctx) const
	Access the current event's McEventCollection (const).

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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.

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
Herwig7API	m_api
	Herwig7 API object.
ThePEG::EGPtr	m_gen
	ThePEG generator object.
ThePEG::EventPtr	m_event
	ThePEG event object.
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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
Properties
std::string	m_runname
	Run name, used in the Herwig/ThePEG config system.
std::string	m_runfile
	Name of run file.
std::string	m_runSettings
	In-memory run settings provided by CA fragments.
std::string	m_setupfile
	Name of setup file.
bool	m_use_seed_from_generatetf
	Ignore random number seed provided by athena and use the one from Generate_tf.py instead.
int	m_seed_from_generatetf
	Random number seed from Generate_tf.py.
std::string	m_pdfname_me
	ME PDF name, stored for AMI capture at finalize.
std::string	m_pdfname_mpi
	PS PDF name, stored for AMI capture at finalize.
bool	m_cleanup_herwig_scratch
	Possibly remove Herwig-scratch folder after finishing the event generation.
double	m_xsscale
	Scale integrated cross section by a factor for MetaData output.
int	m_dsid
	Gen_tf.py run args needed in interface.
SG::ReadHandleKey< xAOD::EventInfo >	m_evtInfoKey

Features for derived classes to use internally
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members.
ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service.
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.
std::shared_ptr< HepMC3::GenRunInfo >	m_runinfo {}
	The run info for HepMC3.
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

Properties
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
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.

Detailed Description

Interface to athena.

Definition at line 130 of file Herwig7.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

Herwig7()

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

Constructor.

Definition at line 41 of file Herwig7.cxx.

                                                                :
  GenModule(name, pSvcLocator),
  m_use_seed_from_generatetf(false),
  m_seed_from_generatetf(0),
  m_pdfname_me("UNKNOWN"), m_pdfname_mpi("UNKNOWN") // m_pdfname_ps("UNKONWN"),
{
  declareProperty("RunFile", m_runfile="Herwig7");
  declareProperty("RunSettings", m_runSettings="");
  declareProperty("SetupFile", m_setupfile="");
 
  declareProperty("UseRandomSeedFromGeneratetf", m_use_seed_from_generatetf);
  declareProperty("RandomSeedFromGeneratetf", m_seed_from_generatetf);
 
  declareProperty("PDFNameME", m_pdfname_me);
  // declareProperty("PDFNamePS", m_pdfname_ps);
  declareProperty("PDFNameMPI", m_pdfname_mpi);
 
  declareProperty("CrossSectionScaleFactor", m_xsscale=1.0);
 
  declareProperty("CleanupHerwigScratch", m_cleanup_herwig_scratch);
 
  declareProperty("Dsid", m_dsid);
}

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 74 of file GenBase.h.

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

callGenerator()

StatusCode Herwig7::callGenerator ( )

virtual

Run the generator for one event.

Run the generator for one event and store the event internally.

Reimplemented from GenModule.

Definition at line 197 of file Herwig7.cxx.

                                  {
  ATH_MSG_DEBUG("Herwig7 generating an event");
  assert(m_gen);
  m_event = m_gen->shoot();
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

event_const()

const HepMC::GenEvent * GenBase::event_const ( const EventContext & ctx ) const

inlineinherited

Access the current signal event (const).

Definition at line 81 of file GenBase.h.

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

events_const()

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

inlineinherited

Access the current event's McEventCollection (const).

Definition at line 95 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< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode GenModule::execute ( const EventContext & ctx )

virtualinherited

Execute method.

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)
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
 
  // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
  //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< Gaudi::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 & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 89 of file AthCommonAlgorithm.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 BaseAlg::extraOutputDeps();
}

fillEvt()

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

virtual

Convert the generated event into the HepMC format.

Fill HepMC event from Herwig's internally stored EventPtr.

Todo

Conversion to HepMC format will possibly be provided by the authors as part of a higher-level API.

Implements GenModule.

Definition at line 212 of file Herwig7.cxx.

                                              {
  // Convert the Herwig event into the HepMC GenEvent
  ATH_MSG_DEBUG("Converting ThePEG::Event to HepMC::GenEvent");
  if (!evt->run_info()) evt->set_run_info(m_runinfo);
  evt->set_units(HepMC3::Units::MEV, HepMC3::Units::MM);
  convert_to_HepMC(*m_event, *evt, false, ThePEG::MeV, ThePEG::millimeter);
  ATH_MSG_DEBUG("Converted ThePEG::Event to HepMC::GenEvent");
 
  // Fill the event number into HepMC event record
  SG::ReadHandle<xAOD::EventInfo> evtInfo(m_evtInfoKey);
  evt->set_event_number(evtInfo->eventNumber());
 
  // Fill event with random seeds from Atlas RNG service
  const EventContext& ctx = Gaudi::Hive::currentContext();
  const long* s = this->getRandomEngine("Herwig7", ctx)->getSeeds();
  std::vector<long> seeds(s, s+2);
  ATH_MSG_DEBUG("Random seeds: " << seeds[0] << ", " << seeds[1]);
  HepMC::set_random_states(evt,seeds);
 
  // Add a unit entry to the event weight vector if it's currently empty
  if (evt->weights().empty()) {
    evt->weights().push_back(m_event->weight());
  }
 
  // Add PDF info manually (for now, until natively supported in the ThePEG converter)
  ATH_MSG_DEBUG("Adding PDF info to HepMC");
  // IDs of the partons going into the primary sub process
  ThePEG::tSubProPtr sub = m_event->primarySubProcess();
  int id1 = sub->incoming().first ->id();
  int id2 = sub->incoming().second->id();
  // Get the event handler
  ThePEG::tcEHPtr eh = ThePEG::dynamic_ptr_cast<ThePEG::tcEHPtr>(m_event->handler());
  // Get the values of x
  double x1 = eh->lastX1();
  double x2 = eh->lastX2();
  // Get the pdfs
  std::pair<ThePEG::PDF,ThePEG::PDF> pdfs;
  pdfs.first  = eh->pdf<ThePEG::PDF>(sub->incoming().first);
  pdfs.second = eh->pdf<ThePEG::PDF>(sub->incoming().second);
  // Get the scale
  ThePEG::Energy2 scale = eh->lastScale();
  double Q = std::sqrt(scale/ThePEG::GeV2);
  // Get the values of the pdfs
  double pdf1 = pdfs.first.xfx(sub->incoming().first ->dataPtr(), scale, x1);
  double pdf2 = pdfs.first.xfx(sub->incoming().second->dataPtr(), scale, x2);
  // Create the PDFinfo object
  HepMC3::GenPdfInfoPtr pdfi = std::make_shared<HepMC3::GenPdfInfo>();
  pdfi->set(id1, id2, x1, x2, Q, pdf1, pdf2);
  evt->set_pdf_info(std::move(pdfi));
  ATH_MSG_DEBUG("Added PDF info to HepMC");
 
//uncomment to list HepMC events
//    std::cout << " print::listing Herwig7 " << std::endl;
//    HepMC3::Print::listing(std::cout, *evt);
 
  return StatusCode::SUCCESS;
}

filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode GenModule::finalize ( )

inlineinherited

Definition at line 55 of file GenModule.h.

{ return genFinalize(); }

genFinalize()

StatusCode Herwig7::genFinalize ( )

virtual

Close down the generator.

Tidy up, print out run stats, etc.

Todo

Think of other way to wait for all access to terminate

Reimplemented from GenModule.

Definition at line 275 of file Herwig7.cxx.

                                {
  ATH_MSG_INFO("Herwig7 finalizing.");
  assert(m_gen);
  ATH_MSG_INFO( "MetaData: generator = Herwig7 " << HWVERSION ); 
  ATH_MSG_INFO( std::scientific << std::setprecision(5) << "MetaData: cross-section (nb) = " << m_gen->eventHandler()->integratedXSec()*m_xsscale/ThePEG::nanobarn); 
  // ATH_MSG_INFO( "MetaData: PDF = " << m_pdfname_me << " (ME); " << m_pdfname_ps << " (shower); " << m_pdfname_mpi << " (MPI)" ); 
  ATH_MSG_INFO("MetaData: PDF = " << m_pdfname_me << " (ME); " << m_pdfname_mpi << " (shower/MPI)");
  m_gen->finalize();
  ThePEG::Repository::cleanup();
 
  // possibly tidy up working directory
  if (m_cleanup_herwig_scratch && (std::filesystem::is_directory("Herwig-scratch") || std::filesystem::is_directory("Herwig-cache"))){
 
    ATH_MSG_INFO("removing Herwig-scratch/Herwig-cache folder from "+std::filesystem::current_path().string());
 
    // sleep for some time to allow all access to terminate
    std::this_thread::sleep_for(std::chrono::seconds(5)); 
 
    // in case the folder can't be deleted continue with warning
    try {
      (std::filesystem::remove_all("Herwig-scratch") || std::filesystem::remove_all("Herwig-cache"));
    } 
    catch (const std::exception& e) {
      ATH_MSG_WARNING("Failed to delete the folder 'Herwig-scratch': "+std::string(e.what()));
    }
 
  }
 
  return StatusCode::SUCCESS;
}

genInitialize()

StatusCode Herwig7::genInitialize ( )

virtual

Initialize the generator.

Todo

Higher-level API to be provided by the Herwig authors to allow for slimmer interface and for usage of more advanced features such as the setupfile mechanism for modifying existing runfiles.

Here one can fill extra information, e.g. the used tools in a format generator name, version string, comment.

Reimplemented from GenModule.

Definition at line 70 of file Herwig7.cxx.

                                  {
  ATH_MSG_INFO("Herwig7 initialising...");
 
  ATH_CHECK(m_evtInfoKey.initialize());
 
  // Get random number seeds from Atlas RNG service, and pass them as Hw7 RNG
  // default seeds (they can be overridden with an explicit Hw7 set command in the JO)
  CLHEP::HepRandomEngine* engine = this->getRandomEngineDuringInitialize("Herwig7", m_randomSeed); // conditionsRun=1, lbn=1
  const long* seeds = engine->getSeeds();
  // The RNG service supplies two seeds, but Hw7 only uses one. To avoid the situation
  // where varying one seed has no effect (this already stung us in pre-production
  // job transform tests), we multiply the two seeds and let them wrap around the long
  // type MAX_SIZE:
  int32_t combined_seed = std::abs(seeds[0] * seeds[1]);
  // Represent the combined seed as a string, so the config system can parse it back to a long ;)
  std::ostringstream ss_seed;
  ss_seed << combined_seed;
  // Configure the API and print the seed to the log
  if (m_use_seed_from_generatetf){
    ATH_MSG_INFO("Using the random number seed " + std::to_string(m_seed_from_generatetf) + " provided via Generate_tf.py");
    m_api.seed(m_seed_from_generatetf);
  } else {
    ATH_MSG_INFO("Using the random number seed " + ss_seed.str() + " provided by athena");
    m_api.seed(combined_seed);
  }
 
  // Change repo log level and make sure that config errors result in a program exit
  //ThePEG::Debug::level = 10000;
  ThePEG::Repository::exitOnError() = 1;
 
  // Use everything from $DATAPATH and $LD_LIBRARY_PATH:
  const char* datapath = getenv( "DATAPATH" );
  std::vector<std::string> datapaths;
  if (datapath) {
      std::string datapath_str(datapath);
      for (auto part : std::views::split(datapath_str, ':')) {
          datapaths.emplace_back(part.begin(), part.end());
      }
  }
  for( const std::string& p : datapaths ) {
    ThePEG::Repository::appendReadDir( p );
  }
  const char* ldpath = getenv( "LD_LIBRARY_PATH" );
  std::vector<std::string> ldpaths;
  if (ldpath) {
      std::string ldpath_str(ldpath);
      for (auto part : ldpath_str | std::views::split(':')) {
          ldpaths.emplace_back(std::string(part.begin(), part.end()));
      }
  }
  for( const std::string& p : ldpaths ) {
    ThePEG::DynamicLoader::appendPath( p );
  }
 
  ATH_MSG_DEBUG("Num of library search paths = " << ThePEG::DynamicLoader::allPaths().size());
 
  // Use PathResolver to find default Hw7 ThePEG repository file.
  const std::string repopath = PathResolver::find_file_from_list("HerwigDefaults.rpo", datapath);
  ATH_MSG_DEBUG("Loading Herwig default repo from " << repopath);
  ThePEG::Repository::load(repopath);
  ATH_MSG_DEBUG("Successfully loaded Herwig default repository");
 
  const std::string share_path = std::filesystem::path(std::move(repopath)).parent_path().string();
 
  if (!m_runSettings.empty()) {
    ATH_CHECK(writeRunFileFromText(share_path));
  }
 
  ATH_MSG_INFO("Setting runfile name '"+m_runfile+"'");
  m_api.inputfile(m_runfile);
 
  ATH_MSG_INFO("starting to prepare the run from runfile '"+m_runfile+"'...");
 
  m_runinfo = std::make_shared<HepMC3::GenRunInfo>();
  struct HepMC3::GenRunInfo::ToolInfo generator={std::string("Herwig7"), Herwig::HerwigStrategy::version, std::string("Used generator")};
  m_runinfo->tools().push_back(std::move(generator));  
  // read in a Herwig runfile and obtain the event generator
  m_gen = Herwig::API::prepareRun(m_api);
  ATH_MSG_DEBUG("preparing the run...");
 
  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.

{ 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< Gaudi::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.

isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

{ return false; }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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.

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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::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< Gaudi::Algorithm > >.

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

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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< Gaudi::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< Gaudi::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);
      }
    }
  }

writeRunFileFromText()

StatusCode Herwig7::writeRunFileFromText

(

const std::string &

share_path

)

Write the CA input text into a real Herwig runfile.

Definition at line 155 of file Herwig7.cxx.

                                                                    {
  if (m_runSettings.empty()) {
    return StatusCode::SUCCESS;
  }
 
  std::string inputfile_name = m_runfile;
  const std::string runfile_suffix = ".run";
  const auto suffix_pos = inputfile_name.rfind(runfile_suffix);
  if (suffix_pos != std::string::npos) {
    inputfile_name.replace(suffix_pos, runfile_suffix.size(), ".in");
  } else {
    std::filesystem::path inputfile_path(m_runfile);
    inputfile_path.replace_extension(".in");
    inputfile_name = inputfile_path.string();
  }
 
  ATH_MSG_INFO("Writing CA infile text to '"+inputfile_name+"'");
  std::ofstream infile_stream(inputfile_name);
  infile_stream << m_runSettings;
  if (!infile_stream) {
    ATH_MSG_ERROR("Failed to write CA infile text to '"+inputfile_name+"'");
    return StatusCode::FAILURE;
  }
 
  if (share_path.empty()) {
    ATH_MSG_ERROR("Could not determine the Herwig share path for CA infile materialisation");
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("Preparing Herwig runfile from CA infile '"+inputfile_name+"'");
  m_api.prependReadDirectory(share_path);
  m_api.inputfile(inputfile_name);
  Herwig::API::read(m_api);
  ATH_MSG_INFO("Finished materialising runfile '"+m_runfile+"'");
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_api

Herwig7API Herwig7::m_api

private

Herwig7 API object.

Definition at line 156 of file Herwig7.h.

m_cleanup_herwig_scratch

bool Herwig7::m_cleanup_herwig_scratch

private

Possibly remove Herwig-scratch folder after finishing the event generation.

Definition at line 198 of file Herwig7.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_dsid

int Herwig7::m_dsid

private

Gen_tf.py run args needed in interface.

Definition at line 204 of file Herwig7.h.

m_event

ThePEG::EventPtr Herwig7::m_event

private

ThePEG event object.

Definition at line 162 of file Herwig7.h.

m_evtInfoKey

SG::ReadHandleKey<xAOD::EventInfo> Herwig7::m_evtInfoKey

private

Initial value:

{this
      , "EventInfo"
      ,  "TMPEvtInfo"
      , "ReadHandleKey for xAOD::EventInfo"}

Definition at line 206 of file Herwig7.h.

                                              {this
      , "EventInfo"
      ,  "TMPEvtInfo"
      , "ReadHandleKey for xAOD::EventInfo"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_gen

ThePEG::EGPtr Herwig7::m_gen

private

ThePEG generator object.

Definition at line 159 of file Herwig7.h.

m_incidentSvc

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

privateinherited

Handle on the incident service.

Definition at line 99 of file GenModule.h.

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

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.

{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 110 of file GenBase.h.

{};

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 119 of file GenBase.h.

{ 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 112 of file GenBase.h.

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

m_pdfname_me

std::string Herwig7::m_pdfname_me

private

ME PDF name, stored for AMI capture at finalize.

Definition at line 189 of file Herwig7.h.

m_pdfname_mpi

std::string Herwig7::m_pdfname_mpi

private

PS PDF name, stored for AMI capture at finalize.

MPI PDF name, stored for AMI capture at finalize.

Definition at line 195 of file Herwig7.h.

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.

{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 97 of file GenModule.h.

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

m_runfile

std::string Herwig7::m_runfile

private

Name of run file.

Definition at line 172 of file Herwig7.h.

m_runinfo

std::shared_ptr<HepMC3::GenRunInfo> GenModule::m_runinfo {}

protectedinherited

The run info for HepMC3.

Definition at line 90 of file GenModule.h.

{};

m_runname

std::string Herwig7::m_runname

private

Run name, used in the Herwig/ThePEG config system.

Definition at line 169 of file Herwig7.h.

m_runSettings

std::string Herwig7::m_runSettings

private

In-memory run settings provided by CA fragments.

These are written to m_runfile.

Definition at line 176 of file Herwig7.h.

m_seed_from_generatetf

int Herwig7::m_seed_from_generatetf

private

Random number seed from Generate_tf.py.

Definition at line 186 of file Herwig7.h.

m_setupfile

std::string Herwig7::m_setupfile

private

Name of setup file.

Definition at line 179 of file Herwig7.h.

m_use_seed_from_generatetf

bool Herwig7::m_use_seed_from_generatetf

private

Ignore random number seed provided by athena and use the one from Generate_tf.py instead.

Definition at line 183 of file Herwig7.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_xsscale

double Herwig7::m_xsscale

private

Scale integrated cross section by a factor for MetaData output.

Definition at line 201 of file Herwig7.h.

---

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

• Herwig7.h
• Herwig7.cxx