TG4RunManager.cxx

Go to the documentation of this file.

//------------------------------------------------
// The Geant4 Virtual Monte Carlo package
// Copyright (C) 2007 - 2015 Ivana Hrivnacova
// All rights reserved.
//
// For the licensing terms see geant4_vmc/LICENSE.
// Contact: root-vmc@cern.ch
//-------------------------------------------------

 
#include "TG4RunManager.h"
#include "TG4ActionInitialization.h"
#include "TG4DetConstruction.h"
#include "TG4EventAction.h"
#include "TG4G3PhysicsManager.h"
#include "TG4GeometryManager.h"
#include "TG4GeometryServices.h"
#include "TG4Globals.h"
#include "TG4PhysicsManager.h"
#include "TG4PostDetConstruction.h"
#include "TG4RegionsManager.h"
#include "TG4RegionsManager2.h"
#include "TG4RunConfiguration.h"
#include "TG4SDConstruction.h"
#include "TG4SDManager.h"
#include "TG4SDServices.h"
#include "TG4SpecialPhysicsList.h"
#include "TG4StackPopper.h"
#include "TG4StateManager.h"
#include "TG4StepManager.h"
#include "TG4SteppingAction.h"
#include "TG4TrackManager.h"
#include "TG4TrackingAction.h"
#include "TG4WorkerInitialization.h"
 
#include <G4Threading.hh>
#include <G4Types.hh>
#ifdef G4MULTITHREADED
#include <G4MTRunManager.hh>
#else
#include <G4RunManager.hh>
#endif
 
#include <G4ScoringManager.hh>
#include <G4VScoringMesh.hh>
 
#include <G4UIExecutive.hh>
#include <G4UImanager.hh>
#include <G4UIsession.hh>
#include <G4Version.hh>
#include <Randomize.hh>
 
#ifdef USE_G4ROOT
#include <TG4RootNavMgr.h>
#endif
 
#include <TGeoManager.h>
#include <TInterpreter.h>
#include <TMCManager.h>
#include <TMCManagerStack.h>
#include <TROOT.h>
#include <TRandom.h>
#include <TRint.h>
#include <TVirtualMC.h>
#include <TVirtualMCApplication.h>
 
namespace
{
 
TG4EventAction* GetEventAction()
{
  return dynamic_cast<TG4EventAction*>(const_cast<G4UserEventAction*>(
    G4RunManager::GetRunManager()->GetUserEventAction()));
}
 
} // namespace
 
//_____________________________________________________________________________
TG4RunManager* TG4RunManager::fgMasterInstance = 0;
G4ThreadLocal TG4RunManager* TG4RunManager::fgInstance = 0;
 
//_____________________________________________________________________________
TG4RunManager::TG4RunManager(
  TG4RunConfiguration* runConfiguration, int argc, char** argv)
  : TG4Verbose("runManager"),
    fRunManager(0),
    fMessenger(this),
    fRunConfiguration(runConfiguration),
    fRegionsManager(0),
    fGeantUISession(0),
    fRootUISession(0),
    fRootUIOwner(false),
    fARGC(argc),
    fARGV(argv),
    fUseRootRandom(true),
    fIsMCStackCached(false),
    fHasEventByEventInitialization(false),
    fNEventsProcessed(0),
    fInProcessRun(false)
{
 
  if (VerboseLevel() > 1) {
    G4cout << "TG4RunManager::TG4RunManager " << this << G4endl;
  }
 
  if (fgInstance) {
    TG4Globals::Exception("TG4RunManager", "TG4RunManager",
      "Cannot create two instances of singleton.");
  }
 
  if (!fRunConfiguration) {
    TG4Globals::Exception("TG4RunManager", "TG4RunManager",
      "Cannot create instance without runConfiguration.");
  }
 
  fgInstance = this;
 
  // Define fARGV, fARGC if not provided
  if (fARGC == 0) {
    fARGC = 1;
    fARGV = (char**)new char*[fARGC];
    fARGV[0] = StrDup("undefined");
  }
 
  G4bool isMaster = !G4Threading::IsWorkerThread();
 
  if (isMaster) {
    fgMasterInstance = this;
    if (runConfiguration->IsUseOfG4Scoring()) {
      // activate G4 command-line scoring
      G4ScoringManager::GetScoringManager();
    }
    // create and configure G4 run manager
    ConfigureRunManager();
  }
  else {
    // Get G4 worker run manager
    fRunManager = G4RunManager::GetRunManager();
 
    // Clone G4Root navigator if needed
    CloneRootNavigatorForWorker();
 
    fRegionsManager = fgMasterInstance->fRegionsManager;
    fRootUISession = fgMasterInstance->fRootUISession;
    fGeantUISession = fgMasterInstance->fGeantUISession;
  }
 
  if (VerboseLevel() > 1) {
    G4cout << "TG4RunManager has been created." << this << G4endl;
  }
}
 
//_____________________________________________________________________________
TG4RunManager::~TG4RunManager()
{
 
  G4bool isMaster = !G4Threading::IsWorkerThread();
 
  if (isMaster) {
    delete fRunConfiguration;
    delete fRegionsManager;
    delete fGeantUISession;
    delete fRunManager;
    if (fRootUIOwner) delete fRootUISession;
    fgMasterInstance = 0;
  }
  fgInstance = 0;
}
 
//
// private methods
//
 
//_____________________________________________________________________________
void TG4RunManager::ConfigureRunManager()
{
 
  // Geometry construction and navigator
  //
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::ConfigureRunManager " << this << G4endl;
 
  TString userGeometry = fRunConfiguration->GetUserGeometry();
 
  TG4GeometryManager::Instance()->SetUserRegionConstruction(
    fRunConfiguration->CreateUserRegionConstruction());
 
  TG4GeometryManager::Instance()->SetUserPostDetConstruction(
    fRunConfiguration->CreateUserPostDetConstruction());
 
  // Root navigator
#ifdef USE_G4ROOT
  TG4RootNavMgr* rootNavMgr = 0;
  if (userGeometry == "VMCtoRoot" || userGeometry == "Root") {
    if (!TMCManager::Instance()) {
 
#if ROOT_VERSION_CODE >= ROOT_VERSION(6, 22, 8)
      // Set Root default units to TGeo
      TGeoManager::LockDefaultUnits(false);
      TGeoManager::SetDefaultUnits(TGeoManager::kRootUnits);
      TGeoManager::LockDefaultUnits(true);
#endif
 
      // Construct geometry via VMC application
      if (TG4GeometryManager::Instance()->VerboseLevel() > 0)
        G4cout << "Running TVirtualMCApplication::ConstructGeometry"
               << std::endl;
 
      TG4StateManager::Instance()->SetNewState(kConstructGeometry);
      TVirtualMCApplication::Instance()->ConstructGeometry();
      TG4StateManager::Instance()->SetNewState(kNotInApplication);
 
      // Set top volume and close Root geometry if not yet done
      if (!gGeoManager->IsClosed()) {
        TGeoVolume* top = (TGeoVolume*)gGeoManager->GetListOfVolumes()->First();
        gGeoManager->SetTopVolume(top);
        gGeoManager->CloseGeometry();
      }
 
      // Now that we have the ideal geometry, call application misalignment code
      TG4StateManager::Instance()->SetNewState(kMisalignGeometry);
      TVirtualMCApplication::Instance()->MisalignGeometry();
      TG4StateManager::Instance()->SetNewState(kNotInApplication);
    }
    // Pass geometry to G4Root navigator
    rootNavMgr = TG4RootNavMgr::GetInstance(gGeoManager);
  }
#endif
 
  // G4 run manager
#ifdef G4MULTITHREADED
  if (fRunConfiguration->IsMTApplication()) {
    fRunManager = new G4MTRunManager();
    fRunManager->SetUserInitialization(new TG4WorkerInitialization());
  }
  else {
    fRunManager = new G4RunManager();
  }
#else
  fRunManager = new G4RunManager();
#endif
  if (VerboseLevel() > 1) {
    G4cout << "G4RunManager has been created." << G4endl;
  }
 
  if (userGeometry != "VMCtoRoot" && userGeometry != "Root") {
    fRunManager->SetUserInitialization(
      fRunConfiguration->CreateDetectorConstruction());
    if (VerboseLevel() > 1)
      G4cout << "CreateDetectorConstruction done." << G4endl;
  }
  else {
#ifdef USE_G4ROOT
    G4int nthreads = 1;
#ifdef G4MULTITHREADED
    if (fRunConfiguration->IsMTApplication()) {
      nthreads = G4MTRunManager::GetMasterRunManager()->GetNumberOfThreads();
    }
#endif
    rootNavMgr->Initialize(new TG4PostDetConstruction(), nthreads);
    rootNavMgr->ConnectToG4();
#else
    TG4Globals::Exception("TG4RunManager", "ConfigureRunManager",
      "geomVMCtoRoot and geomRoot options require Geant4 VMC built with "
      "G4Root.");
#endif
  }
 
  // Other mandatory classes
  //
  fRunManager->SetUserInitialization(fRunConfiguration->CreatePhysicsList());
  if (VerboseLevel() > 1) G4cout << "CreatePhysicsList done." << G4endl;
 
  // User fast simulation
  TG4VUserFastSimulation* userFastSimulation =
    fRunConfiguration->CreateUserFastSimulation();
  if (userFastSimulation) {
    if (TG4SpecialPhysicsList::Instance()) {
      TG4SpecialPhysicsList::Instance()->SetUserFastSimulation(
        userFastSimulation);
    }
    else {
      TG4Globals::Warning("TG4RunManager", "ConfigureRunManager",
        "TG4SpecialPhysicsList  must be instantiated to use fast simulation");
    }
  }
 
  fRunManager->SetUserInitialization(
    new TG4ActionInitialization(fRunConfiguration));
  if (VerboseLevel() > 1)
    G4cout << "Create ActionInitialization done." << G4endl;
 
  // Regions manager
  //
  if (fRunConfiguration->IsSpecialCuts()) {
    if (fRunConfiguration->IsSpecialCutsOld()) {
      fRegionsManager = new TG4RegionsManager();
    }
    else {
      fRegionsManager = new TG4RegionsManager2();
    }
  }
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::ConfigureRunManager done " << this << G4endl;
}
 
//_____________________________________________________________________________
void TG4RunManager::CloneRootNavigatorForWorker()
{
  // Clone Root navigator for worker thread
  //
#ifdef USE_G4ROOT
  TString userGeometry = fRunConfiguration->GetUserGeometry();
  if (userGeometry != "VMCtoRoot" && userGeometry != "Root") return;
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::CloneRootNavigatorForWorker " << this << G4endl;
 
  // Master Root navigator
  TG4RootNavMgr* masterRootNavMgr = TG4RootNavMgr::GetMasterInstance();
 
  // Create G4Root navigator on worker
  TG4RootNavMgr* rootNavMgr = TG4RootNavMgr::GetInstance(*masterRootNavMgr);
  if (VerboseLevel() > 1)
    G4cout << "TG4RootNavMgr has been created." << rootNavMgr << G4endl;
 
  // rootNavMgr->Initialize(new TG4PostDetConstruction());
  rootNavMgr->ConnectToG4();
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::CloneRootNavigatorForWorker done " << this
           << G4endl;
#endif
}
 
//_____________________________________________________________________________
void TG4RunManager::CreateRootUI()
{
 
  // get Root UI session if it exists
  fRootUISession = gROOT->GetApplication();
  if (fRootUISession) {
    fARGC = fRootUISession->Argc();
    delete[] fARGV;
    fARGV = fRootUISession->Argv();
  }
 
  // filter out "-splash" from argument list
  FilterARGV("-splash");
 
  // create root UI if it does not exist
  if (!fRootUISession) {
    // copy only first command line argument (name of program)
    // (use the same way as in TApplication.cxx)
    char** argv = 0;
    if (fARGC > 0) {
      argv = (char**)new char*[fARGC];
    }
 
    // copy command line arguments, can be later accessed via Argc() and Argv()
    for (int i = 0; i < fARGC; i++) {
      argv[i] = StrDup(fARGV[i]);
    }
 
    fRootUISession = new TRint("rootSession", &fARGC, argv, 0, 0);
    fRootUIOwner = true;
  }
}
 
//_____________________________________________________________________________
void TG4RunManager::FilterARGV(const G4String& arg)
{
 
  if (fARGC <= 1) return;
 
  G4bool isArg = false;
  for (G4int i = 0; i < fARGC; i++) {
    if (G4String(fARGV[i]) == arg) isArg = true;
    if (isArg && i + 1 < fARGC) fARGV[i] = fARGV[i + 1];
  }
 
  if (isArg) fARGC--;
}
 
//_____________________________________________________________________________
void TG4RunManager::SetRandomSeed()
{
 
  long seeds[10];
  seeds[0] = gRandom->GetSeed();
  seeds[1] = gRandom->GetSeed();
  seeds[2] = 0;
  CLHEP::HepRandom::setTheSeeds(seeds);
}
 
// public methods
 
//_____________________________________________________________________________
void TG4RunManager::Initialize()
{
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::Initialize " << this << G4endl;
 
  // create G4RunManager
  // ConfigureRunManager();
 
#if G4VERSION_NUMBER == 1100
  // Temporary work-around for bug in Cerenkov in Geant4 11.0
  TG4PhysicsManager::Instance()->StoreCerenkovMaxBetaChangeValue();
#endif
 
  // initialize Geant4
  fRunManager->Initialize();
 
  // finish geometry
  TG4GeometryManager::Instance()->FinishGeometry();
 
  // initialize SD manager
  // TG4SDManager::Instance()->Initialize();
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::Initialize done " << this << G4endl;
}
 
//_____________________________________________________________________________
void TG4RunManager::LateInitialize()
{
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::LateInitialize " << this << G4endl;
 
  G4bool isMaster = !G4Threading::IsWorkerThread();
 
  // define particles
  TG4PhysicsManager::Instance()->DefineParticles();
 
  // set user limits
  if (isMaster) {
    TG4GeometryManager::Instance()->SetUserLimits(
      *TG4G3PhysicsManager::Instance()->GetCutVector(),
      *TG4G3PhysicsManager::Instance()->GetControlVector());
 
    // pass info if cut on e+e- pair is activated to stepping action
    // TO DO LATER - Stepping Action NOT AVAILABLE
    //((TG4SteppingAction*)fRunManager->GetUserSteppingAction())
    //  ->SetIsPairCut((*TG4G3PhysicsManager::Instance()->GetIsCutVector())[kEplus]);
 
    // convert tracking cuts in range cuts per regions
    if (fRunConfiguration->IsSpecialCuts()) {
      fRegionsManager->DefineRegions();
      fRegionsManager->UpdateProductionCutsTable();
    }
  }
 
  // activate/inactivate physics processes
  TG4PhysicsManager::Instance()->SetProcessActivation();
  TG4PhysicsManager::Instance()->RetrieveOpBoundaryProcess();
 
  // late initialize SD manager
  // (needed only if user sets score weight calculator)
  if (fRunConfiguration->IsUseOfScoreWeighting()) {
    TG4SDManager::Instance()->LateInitialize(fRunConfiguration->GetScoreWeightCalculator());
  }
 
  // late initialize step manager
  TG4StepManager::Instance()->LateInitialize();
 
  // late initialize action classes
  if (GetEventAction()) {
    GetEventAction()->LateInitialize();
    TG4TrackingAction::Instance()->LateInitialize();
    TG4SteppingAction::Instance()->LateInitialize();
  }
 
  // print statistics
  TG4GeometryServices::Instance()->PrintStatistics(true, false);
  TG4SDServices::Instance()->PrintStatistics(false, true);
 
  if (VerboseLevel() > 2) {
    TG4GeometryServices::Instance()->PrintLogicalVolumeStore();
  }
 
  // set the random number seed
  if (fUseRootRandom) SetRandomSeed();
 
  if (VerboseLevel() > 1)
    G4cout << "TG4RunManager::LateInitialize done " << this << G4endl;
}
 
//_____________________________________________________________________________
void TG4RunManager::CacheMCStack()
{
 
  // Do only once
  if (fIsMCStackCached) return;
 
  // The VMC stack must be set to MC at this stage !!
  TVirtualMCStack* mcStack = gMC->GetStack();
  if (!mcStack) {
    TG4Globals::Exception(
      "TG4RunManager", "CacheMCStack", "VMC stack is not set");
    return;
  }
 
  TMCManagerStack* mcManagerStack = gMC->GetManagerStack();
  // Set stack to the event actions if they exists
  // (on worker only if in MT mode)
  if (GetEventAction()) {
    GetEventAction()->SetMCStack(mcStack);
    TG4TrackingAction::Instance()->SetMCStack(mcStack);
    TG4TrackManager::Instance()->SetMCStack(mcStack);
    TG4TrackManager::Instance()->SetMCManagerStack(mcManagerStack);
 
    if (TG4StackPopper::Instance()) {
      TG4StackPopper::Instance()->SetMCStack(mcStack);
    }
  }
 
  fIsMCStackCached = true;
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessEvent()
{
 
  ProcessEvent(fNEventsProcessed++, false);
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessEvent(G4int eventId, G4bool isInterruptible)
{
 
  // First, replay what is done in G4RunManager::BeamOn(...) explicitly
  if (!fHasEventByEventInitialization) {
    G4bool cond = fRunManager->ConfirmBeamOnCondition();
    if (!cond) {
      TG4Globals::Warning("TG4RunManager", "ProcessEvent",
        "Bad beam condition in G4RunManager. No event processed.");
      return;
    }
    fRunManager->ConstructScoringWorlds();
    fRunManager->RunInitialization();
    fHasEventByEventInitialization = true;
  }
  GetEventAction()->SetIsInterruptibleEvent(isInterruptible);
 
  // Explicitly call the following 2 methods which are otherwise called from
  // G4RunManager::BeamOn(...)
  fRunManager->ProcessOneEvent(eventId);
  fRunManager->TerminateOneEvent();
}
 
//_____________________________________________________________________________
Bool_t TG4RunManager::ProcessRun(G4int nofEvents)
{
 
  // Runinit for per-event processing ==> Don't allow for process run.
  if (fHasEventByEventInitialization) {
    TG4Globals::Warning("TG4RunManager", "ProcessRun",
      "Current run is terminated first, then the requested run is processed");
    FinishRun();
  }
  fInProcessRun = true;
  fRunManager->BeamOn(nofEvents);
  fInProcessRun = false;
  fNEventsProcessed = nofEvents;
  return FinishRun();
}
 
//_____________________________________________________________________________
Bool_t TG4RunManager::FinishRun()
{
  if (!fHasEventByEventInitialization) {
    if (fInProcessRun) {
      TG4Globals::Warning("TG4RunManager", "FinishRun",
        "You are processing a run. To stop it, call StopRun()");
      return false;
    }
    else {
      fNEventsProcessed = 0;
    }
  }
  else {
    fRunManager->RunTermination();
    fHasEventByEventInitialization = false;
    fNEventsProcessed = 0;
  }
  // Pring field statistics
  TG4GeometryManager::Instance()->PrintFieldStatistics();
 
  G4bool result = !TG4SDServices::Instance()->GetIsStopRun();
  TG4SDServices::Instance()->SetIsStopRun(false);
 
  if (fRunConfiguration->IsUseOfG4Scoring()) {
    // Dump all scoring meshes in file
    auto g4ScoringManager = G4ScoringManager::GetScoringManager();
    for (std::size_t i = 0; i < g4ScoringManager->GetNumberOfMesh(); ++i) {
      auto meshName = g4ScoringManager->GetMesh(i)->GetWorldName();
      auto fileName = meshName + ".txt";
      g4ScoringManager->DumpAllQuantitiesToFile(meshName, fileName);
    }
  }
 
  return result;
}
 
//_____________________________________________________________________________
void TG4RunManager::CreateGeantUI()
{
 
  if (fGeantUISession) return;
 
  // create session if it does not exist
  fGeantUISession = new G4UIExecutive(fARGC, fARGV);
}
 
//_____________________________________________________________________________
void TG4RunManager::StartGeantUI()
{
 
  if (!fGeantUISession) CreateGeantUI();
 
  if (fGeantUISession) {
    // interactive session
    G4cout << "Welcome (back) in Geant4" << G4endl;
    fGeantUISession->GetSession()->SessionStart();
    G4cout << "Welcome (back) in Root" << G4endl;
  }
  else {
    G4cout << "Geant4 UI not available." << G4endl;
  }
}
 
//_____________________________________________________________________________
void TG4RunManager::StartRootUI()
{
 
  if (!fRootUISession) CreateRootUI();
  if (fRootUISession) {
    G4cout << "Welcome (back) in Root" << G4endl;
    fRootUISession->Run(kTRUE);
    G4cout << "Welcome (back) in Geant4" << G4endl;
  }
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessGeantMacro(G4String macroName)
{
 
  G4String command = "/control/execute " + macroName;
  ProcessGeantCommand(command);
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessRootMacro(G4String macroName)
{
 
  // load macro file
  G4String macroFile = macroName;
  macroFile.append(".C");
  gROOT->LoadMacro(macroFile);
 
  // execute macro function
  G4String macroFunction = macroName;
  macroFunction.append("()");
  gInterpreter->ProcessLine(macroFunction);
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessGeantCommand(G4String command)
{
 
  G4UImanager* pUI = G4UImanager::GetUIpointer();
  G4int result = pUI->ApplyCommand(command);
 
  // From G4UIbatch::ExecCommand():
  switch (result) {
    case fCommandSucceeded:
      break;
    case fCommandNotFound:
      G4cerr << "***** COMMAND NOT FOUND <" << command << "> *****" << G4endl;
      break;
    case fIllegalApplicationState:
      G4cerr << "***** Illegal application state <" << command << "> *****"
             << G4endl;
      break;
    default:
      G4int pn = result % 100;
      G4cerr << "***** Illegal parameter (" << pn << ") <" << command
             << "> *****" << G4endl;
  }
}
 
//_____________________________________________________________________________
void TG4RunManager::ProcessRootCommand(G4String command)
{
 
  gInterpreter->ProcessLine(command);
}
 
//_____________________________________________________________________________
void TG4RunManager::UseG3Defaults()
{
 
  TG4G3PhysicsManager::Instance()->SetG3DefaultCuts();
  TG4G3PhysicsManager::Instance()->SetG3DefaultControls();
}
 
//_____________________________________________________________________________
Int_t TG4RunManager::CurrentEvent() const
{
 
  G4int eventID = fRunManager->GetCurrentEvent()->GetEventID();
  return eventID;
}
 
//_____________________________________________________________________________
Bool_t TG4RunManager::SecondariesAreOrdered() const
{
 
  return false;
}