Skip to content

Commit bdec722

Browse files
Benedikt Volkelsawenzel
Benedikt Volkel
authored and
sawenzel
committedDec 14, 2022
Provide trivial MC engine and application
* O2TrivialMC VMC engine with a minimal implementation of interfaces. It does simply calls the hook for primary generation and pops them for consistency. They are not transported. Useful, when only generator level (aka MCKinematics) are needed since it has minimal initialisation overhead. Cannot be used for physics simulation, o2-sim will abort. * O2TrivialMCApplciation VMC application with minimal implementation of interfaces. For the geometry it only constructs a simple box with a vacuum. Non primary generation or anything else. * o2-sim --noGeant automatically runs with the O2trivialMC engine to ensure minimal initialisation overhead. Only CAVE is constructed, all other modules are omitted.
1 parent 109f618 commit bdec722

13 files changed

+1132
-49
lines changed
 

‎Common/SimConfig/src/SimConfig.cxx

+11-1
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,20 @@ bool SimConfig::resetFromParsedMap(boost::program_options::variables_map const&
180180
{
181181
using o2::detectors::DetID;
182182
mConfigData.mMCEngine = vm["mcEngine"].as<std::string>();
183+
mConfigData.mNoGeant = vm["noGeant"].as<bool>();
183184

184185
// get final set of active Modules
185186
determineActiveModules(vm["modules"].as<std::vector<std::string>>(), vm["skipModules"].as<std::vector<std::string>>(), mConfigData.mActiveModules, mConfigData.mIsRun5);
187+
if (mConfigData.mNoGeant) {
188+
// CAVE is all that's needed (and that will be built either way), so clear all modules and set the O2TrivialMCEngine
189+
mConfigData.mActiveModules.clear();
190+
// force usage of O2TrivialMCEngine, no overhead from actual transport engine initialisation
191+
mConfigData.mMCEngine = "O2TrivialMCEngine";
192+
} else if (mConfigData.mMCEngine.compare("O2TrivialMCEngine") == 0) {
193+
LOG(error) << "The O2TrivialMCEngine engine can only be used with --noGeant option";
194+
return false;
195+
}
196+
186197
const auto& activeModules = mConfigData.mActiveModules;
187198

188199
// get final set of detectors which are readout
@@ -215,7 +226,6 @@ bool SimConfig::resetFromParsedMap(boost::program_options::variables_map const&
215226
mConfigData.mRunNumber = vm["run"].as<int>();
216227
mConfigData.mCCDBUrl = vm["CCDBUrl"].as<std::string>();
217228
mConfigData.mAsService = vm["asservice"].as<bool>();
218-
mConfigData.mNoGeant = vm["noGeant"].as<bool>();
219229
mConfigData.mForwardKine = vm["forwardKine"].as<bool>();
220230
mConfigData.mWriteToDisc = !vm["noDiscOutput"].as<bool>();
221231
if (vm.count("noemptyevents")) {

‎Detectors/CMakeLists.txt

+4
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ if(BUILD_SIMULATION)
5353
o2_data_file(COPY gconfig DESTINATION Detectors)
5454
endif()
5555

56+
if(BUILD_SIMULATION)
57+
add_subdirectory(O2TrivialMC)
58+
endif()
59+
5660
o2_data_file(COPY Geometry DESTINATION Detectors)
5761

5862
if(ENABLE_UPGRADES)

‎Detectors/O2TrivialMC/CMakeLists.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2+
# See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3+
# All rights not expressly granted are reserved.
4+
#
5+
# This software is distributed under the terms of the GNU General Public
6+
# License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7+
#
8+
# In applying this license CERN does not waive the privileges and immunities
9+
# granted to it by virtue of its status as an Intergovernmental Organization
10+
# or submit itself to any jurisdiction.
11+
12+
o2_add_library(O2TrivialMC
13+
PUBLIC_LINK_LIBRARIES MC::VMC)
14+
15+
o2_target_root_dictionary(O2TrivialMC
16+
HEADERS include/O2TrivialMC/O2TrivialMCEngine.h
17+
include/O2TrivialMC/O2TrivialMCApplication.h)

‎Detectors/O2TrivialMC/include/O2TrivialMC/O2TrivialMCApplication.h

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2+
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3+
// All rights not expressly granted are reserved.
4+
//
5+
// This software is distributed under the terms of the GNU General Public
6+
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7+
//
8+
// In applying this license CERN does not waive the privileges and immunities
9+
// granted to it by virtue of its status as an Intergovernmental Organization
10+
// or submit itself to any jurisdiction.
11+
12+
// An absolut minimal implementation of a TVirtualMCApplication for studies and code that e.g. only depends on the presence of a VMC.
13+
14+
#ifndef ALICEO2_MC_TRIVIALMCAPPLICATION_H_
15+
#define ALICEO2_MC_TRIVIALMCAPPLICATION_H_
16+
17+
#include "TGeoManager.h"
18+
#include "TGeoBBox.h"
19+
#include "TGeoMaterial.h"
20+
#include "TGeoMedium.h"
21+
22+
#include "TVirtualMCApplication.h"
23+
24+
namespace o2
25+
{
26+
27+
namespace mc
28+
{
29+
30+
class O2TrivialMCApplication : public TVirtualMCApplication
31+
{
32+
public:
33+
O2TrivialMCApplication() : TVirtualMCApplication("O2TrivialMCApplication", "O2TrivialMCApplication") {}
34+
~O2TrivialMCApplication() override = default;
35+
O2TrivialMCApplication(O2TrivialMCApplication const& app) {}
36+
void ConstructGeometry() override
37+
{
38+
auto geoMgr = gGeoManager;
39+
// we need some dummies, any material and medium will do
40+
auto mat = new TGeoMaterial("vac", 0, 0, 0);
41+
auto med = new TGeoMedium("vac", 1, mat);
42+
auto vol = geoMgr->MakeBox("cave", med, 1, 1, 1);
43+
geoMgr->SetTopVolume(vol);
44+
geoMgr->CloseGeometry();
45+
}
46+
void InitGeometry() override {}
47+
void GeneratePrimaries() override {}
48+
void BeginEvent() override {}
49+
void BeginPrimary() override {}
50+
void PreTrack() override {}
51+
void Stepping() override {}
52+
void PostTrack() override {}
53+
void FinishPrimary() override {}
54+
void FinishEvent() override {}
55+
TVirtualMCApplication* CloneForWorker() const override
56+
{
57+
return new O2TrivialMCApplication(*this);
58+
}
59+
};
60+
61+
} // namespace mc
62+
63+
} // namespace o2
64+
65+
#endif

‎Detectors/O2TrivialMC/include/O2TrivialMC/O2TrivialMCEngine.h

+956
Large diffs are not rendered by default.

‎Detectors/O2TrivialMC/src/O2TrivialMCLinkDef.h

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2+
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3+
// All rights not expressly granted are reserved.
4+
//
5+
// This software is distributed under the terms of the GNU General Public
6+
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7+
//
8+
// In applying this license CERN does not waive the privileges and immunities
9+
// granted to it by virtue of its status as an Intergovernmental Organization
10+
// or submit itself to any jurisdiction.
11+
12+
#ifdef __CLING__
13+
14+
#pragma link off all globals;
15+
#pragma link off all classes;
16+
#pragma link off all functions;
17+
18+
#endif

‎Detectors/gconfig/CMakeLists.txt

+10-3
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,22 @@ o2_add_library(G4Setup
2222
o2_add_library(FLUKASetup
2323
SOURCES src/FlukaConfig.cxx
2424
PUBLIC_LINK_LIBRARIES FairRoot::Base O2::SimulationDataFormat O2::Generators ROOT::EGPythia6 O2::SimSetup
25-
)
25+
)
26+
2627
o2_add_library(MCReplaySetup
2728
SOURCES src/MCReplayConfig.cxx
2829
PUBLIC_LINK_LIBRARIES MC::MCReplay FairRoot::Base O2::SimulationDataFormat O2::Generators O2::SimSetup
2930
)
31+
32+
o2_add_library(O2TrivialMCEngineSetup
33+
SOURCES src/O2TrivialMCConfig.cxx
34+
PUBLIC_LINK_LIBRARIES O2::O2TrivialMC FairRoot::Base O2::SimulationDataFormat O2::Generators O2::SimSetup
35+
)
36+
3037
o2_add_library(SimSetup
3138
SOURCES src/GlobalProcessCutSimParam.cxx src/SimSetup.cxx src/SetCuts.cxx src/FlukaParam.cxx src/MCReplayParam.cxx
32-
PUBLIC_LINK_LIBRARIES O2::CommonUtils O2::DetectorsBase O2::SimConfig
33-
)
39+
PUBLIC_LINK_LIBRARIES O2::CommonUtils O2::DetectorsBase O2::SimConfig
40+
)
3441

3542
o2_target_root_dictionary(SimSetup
3643
HEADERS include/SimSetup/SimSetup.h

‎Detectors/gconfig/src/O2TrivialMCConfig.cxx

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2+
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3+
// All rights not expressly granted are reserved.
4+
//
5+
// This software is distributed under the terms of the GNU General Public
6+
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7+
//
8+
// In applying this license CERN does not waive the privileges and immunities
9+
// granted to it by virtue of its status as an Intergovernmental Organization
10+
// or submit itself to any jurisdiction.
11+
#include "FairRunSim.h"
12+
#include "O2TrivialMC/O2TrivialMCEngine.h"
13+
#include "DetectorsBase/Stack.h"
14+
#include "SimulationDataFormat/StackParam.h"
15+
#include <fairlogger/Logger.h>
16+
#include "FairModule.h"
17+
#include "Generators/DecayerPythia8.h"
18+
#include "../commonConfig.C"
19+
20+
// these are used in commonConfig.C
21+
using o2::eventgen::DecayerPythia8;
22+
23+
namespace o2
24+
{
25+
namespace o2trivialmcengineconfig
26+
{
27+
28+
void Config()
29+
{
30+
// TString* gModel = run->GetGeoModel();
31+
FairRunSim* run = FairRunSim::Instance();
32+
auto* replay = new mc::O2TrivialMCEngine();
33+
stackSetup(replay, run);
34+
}
35+
36+
void O2TrivialMCEngineConfig()
37+
{
38+
LOG(info) << "Setting up O2TrivialMCEngine sim from library code";
39+
Config();
40+
}
41+
42+
} // namespace o2trivialmcengineconfig
43+
} // namespace o2

‎Detectors/gconfig/src/SimSetup.cxx

+2
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ void SimSetup::setup(const char* engine)
5858
setupFromPlugin("libO2FLUKASetup", "_ZN2o211flukaconfig11FlukaConfigEv");
5959
} else if (strcmp(engine, "MCReplay") == 0) {
6060
setupFromPlugin("libO2MCReplaySetup", "_ZN2o214mcreplayconfig14MCReplayConfigEv");
61+
} else if (strcmp(engine, "O2TrivialMCEngine") == 0) {
62+
setupFromPlugin("libO2O2TrivialMCEngineSetup", "_ZN2o223o2trivialmcengineconfig23O2TrivialMCEngineConfigEv");
6163
} else {
6264
LOG(fatal) << "Unsupported engine " << engine;
6365
}

‎macro/o2sim.C

+2-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ void check_notransport()
5353
LOG(info) << "Initializing without Geant transport by applying very tight geometry cuts";
5454
o2::conf::ConfigurableParam::setValue("SimCutParams", "maxRTracking", 0.0000001); // 1 nanometer of tracking
5555
o2::conf::ConfigurableParam::setValue("SimCutParams", "maxAbsZTracking", 0.0000001); // 1 nanometer of tracking
56-
// TODO: disable physics processes for material sitting at the vertex
5756
}
5857
}
5958

@@ -121,8 +120,8 @@ FairRunSim* o2sim_init(bool asservice, bool evalmat = false)
121120

122121
std::string outputfilename = s.str();
123122
run->SetSink(new FairRootFileSink(outputfilename.c_str())); // Output file
124-
run->SetName(confref.getMCEngine().c_str()); // Transport engine
125-
run->SetIsMT(confref.getIsMT()); // MT mode
123+
run->SetName(confref.getMCEngine().c_str()); // Transport engine
124+
run->SetIsMT(confref.getIsMT()); // MT mode
126125

127126
/** set event header **/
128127
auto header = new o2::dataformats::MCEventHeader();

‎run/CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ o2_add_executable(hit-merger-runner
9494
o2_add_executable(g4-determine-unknown-pdg-properties
9595
COMPONENT_NAME sim
9696
SOURCES g4DetermineUnknownPdgProperties.cxx
97-
PUBLIC_LINK_LIBRARIES MC::Geant4 MC::Geant4VMC internal::allsim)
97+
PUBLIC_LINK_LIBRARIES O2::O2TrivialMC MC::Geant4 MC::Geant4VMC O2::SimConfig)
9898

9999
o2_add_executable(mctracks-proxy
100100
COMPONENT_NAME sim

‎run/O2SimDevice.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ class O2SimDevice final : public fair::mq::Device
252252

253253
// Process one event
254254
auto& conf = o2::conf::SimConfig::Instance();
255-
if (strcmp(conf.getMCEngine().c_str(), "TGeant4") == 0) {
255+
if (strcmp(conf.getMCEngine().c_str(), "TGeant4") == 0 || strcmp(conf.getMCEngine().c_str(), "O2TrivialMCEngine") == 0) {
256256
// this is preferred and necessary for Geant4
257257
// since repeated "ProcessRun" might have significant overheads
258258
mVMC->ProcessEvent();

‎run/g4DetermineUnknownPdgProperties.cxx

+2-40
Original file line numberDiff line numberDiff line change
@@ -17,51 +17,13 @@
1717
#include "G4ParticleTable.hh"
1818
#include "G4IonTable.hh"
1919

20-
#include "TGeoManager.h"
21-
#include "TGeoBBox.h"
22-
#include "TGeoMaterial.h"
23-
#include "TGeoMedium.h"
24-
25-
#include "TVirtualMCApplication.h"
2620
#include "TGeant4.h"
2721
#include "TG4RunConfiguration.h"
2822
#include "TG4G3Units.h"
2923

3024
#include "SimConfig/G4Params.h"
3125
#include "SimulationDataFormat/O2DatabasePDG.h"
32-
33-
// That is an absolut minimal implementation of a TVirtualMCApplication
34-
// Required to instantiate VMC (see below)
35-
class MCAppDummy : public TVirtualMCApplication
36-
{
37-
public:
38-
MCAppDummy() : TVirtualMCApplication("MCAppDummy", "MCAppDummy") {}
39-
~MCAppDummy() override = default;
40-
MCAppDummy(MCAppDummy const& app) {}
41-
void ConstructGeometry() override
42-
{
43-
auto geoMgr = gGeoManager;
44-
// we need some dummies, any material and medium will do
45-
auto mat = new TGeoMaterial("vac", 0, 0, 0);
46-
auto med = new TGeoMedium("vac", 1, mat);
47-
auto vol = geoMgr->MakeBox("cave", med, 1, 1, 1);
48-
geoMgr->SetTopVolume(vol);
49-
geoMgr->CloseGeometry();
50-
}
51-
void InitGeometry() override {}
52-
void GeneratePrimaries() override {}
53-
void BeginEvent() override {}
54-
void BeginPrimary() override {}
55-
void PreTrack() override {}
56-
void Stepping() override {}
57-
void PostTrack() override {}
58-
void FinishPrimary() override {}
59-
void FinishEvent() override {}
60-
TVirtualMCApplication* CloneForWorker() const override
61-
{
62-
return new MCAppDummy(*this);
63-
}
64-
};
26+
#include "O2TrivialMC/O2TrivialMCApplication.h"
6527

6628
void removeDuplicates(std::vector<int>& vec)
6729
{
@@ -86,7 +48,7 @@ int main(int argc, char** argv)
8648

8749
// We use our O2 VMC setup to make sure we are in line with our physics definition.
8850
// need a dummy VMC App
89-
new MCAppDummy();
51+
new o2::mc::O2TrivialMCApplication();
9052
// setup G4 as we usually do
9153
auto& physicsSetup = ::o2::conf::G4Params::Instance().getPhysicsConfigString();
9254
auto runConfiguration = new TG4RunConfiguration("geomRoot", physicsSetup);

0 commit comments

Comments
 (0)
Please sign in to comment.