RunManager Class Reference

The run manager controls the flow of the Geant4 program and manages the event loop(s) within a run. More...

#include <RunManager.h>

Inheritance diagram for RunManager:

Classes
class	SingletonDestroyer
	Destroyer class to delete the instance of the RunManager class when the program terminates. More...

Public Member Functions
void	beginRun (int runNumber)
	Prepares Geant4 for a new run.
void	processEvent (int evtNumber)
	Process a single event in Geant4.
void	endRun ()
	Terminates a Geant4 run.
void	destroy ()
	Destroys the RunManager at the end of the simulation.
void	Initialize ()
	Initialize the Kernel.
void	addAssemblyVolume (G4AssemblyVolume *vol)
	Register a G4AssemblyVolume.

Static Public Member Functions
static RunManager &	Instance ()
	Static method to get a reference to the RunManager instance.

Private Member Functions
	RunManager ()
	The constructor is hidden to avoid that someone creates an instance of this class.
	RunManager (const RunManager &)
	Disable/Hide the copy constructor.
RunManager &	operator= (const RunManager &)
	Disable/Hide the copy assignment operator.
virtual	~RunManager ()
	The RunManager destructor.

Private Attributes
std::vector< G4AssemblyVolume * >	m_AssemblyVolumes
	Vector of pointers to G4AssemblyVolumes.
RandomEngine *	m_randomEngine
	Pointer to RandomEngine to avoid memory leak by creating it in the constructor and deleting it in the destructor.

Static Private Attributes
static RunManager *	m_instance = NULL
	Pointer that saves the instance of this class.

Friends
class	SingletonDestroyer

Detailed Description

The run manager controls the flow of the Geant4 program and manages the event loop(s) within a run.

The run manager is also responsible for managing initialization procedures, including methods in the user initialization classes. By definition of Geant4, this class has to be a singleton.

Definition at line 32 of file RunManager.h.

Constructor & Destructor Documentation

RunManager()

RunManager ( )

private

The constructor is hidden to avoid that someone creates an instance of this class.

Definition at line 125 of file RunManager.cc.

                       : G4RunManager()
{
  m_AssemblyVolumes.clear();
}

~RunManager()

~RunManager ( )

privatevirtual

The RunManager destructor.

Definition at line 131 of file RunManager.cc.

{
}

Member Function Documentation

addAssemblyVolume()

void addAssemblyVolume ( G4AssemblyVolume *  vol )

inline

Register a G4AssemblyVolume.

Definition at line 68 of file RunManager.h.

{ m_AssemblyVolumes.push_back(vol); }

beginRun()

void beginRun

(

int

runNumber

)

Prepares Geant4 for a new run.

Parameters

runNumber

The current number of the run.

Definition at line 49 of file RunManager.cc.

{
  //Initialize Geometry FIXME: done run independent at the moment
  //InitializeGeometry();
  //Check if all the necessary initializations have already be done.
  if (ConfirmBeamOnCondition()) {
    //Set run number
    SetRunIDCounter(runNumber);
 
    //Finish initialization
    ConstructScoringWorlds();
    RunInitialization();
  } else {
    B2FATAL("The Geant4 kernel was not initialized properly ! The method 'ConfirmBeamOnCondition()' failed. ");
  }
}

destroy()

void destroy

(

)

Destroys the RunManager at the end of the simulation.

Required by Geant4.

Definition at line 85 of file RunManager.cc.

{
  delete m_randomEngine;
 
  if (m_instance == nullptr) return;
 
  for (G4AssemblyVolume* assemblyVolume : m_AssemblyVolumes) delete assemblyVolume;
  m_AssemblyVolumes.clear();
 
  if (ProcHandler::parallelProcessingUsed() and !ProcHandler::isOutputProcess()) {
    //Attention, ugly:
    //Deleting the runmanager will cause Geant4 to open the geometry and clean up
    //optimizations. This will modify the geometry and hurt parallel processing
    //memory usage so we do not want to do this, the operating system
    //will free the memory anyway.
    //So what we do if we are in one of the child processes is to empty the
    //list of pointers in the G4LogicalVolumeStore. This means Geant4 will
    //not find the volumes and will not delete the optimizations. We also clear
    //all the other stores which contain geometry information just to be sure
    G4LogicalVolumeStore::GetInstance()->clear();
    G4PhysicalVolumeStore::GetInstance()->clear();
    G4SolidStore::GetInstance()->clear();
    G4RegionStore::GetInstance()->clear();
    //And we have to open the geometry to avoid warnings from the Stores which
    //is now a trivial operation
    G4GeometryManager::GetInstance()->OpenGeometry();
  } else {
    //If we are the framework process (a.k.a the parent or only process) we do
    //the full cleanup. We could live with the same approach as for child
    //processes but then valgrind will probably show huge memory leaks
    delete m_instance;
  }
  m_instance = nullptr;
}

endRun()

void endRun

(

)

Terminates a Geant4 run.

Definition at line 79 of file RunManager.cc.

{
  RunTermination();
}

Initialize()

void Initialize

(

)

Initialize the Kernel.

Definition at line 35 of file RunManager.cc.

{
  m_randomEngine = new RandomEngine();
  //Set the random number engine
  CLHEP::HepRandom::setTheEngine(m_randomEngine);
 
  SetGeometryToBeOptimized(true);
  //Set geometry to be Initialized because there won't be any before the beginRun
  //FIXME: reverted to run independent
  //geometryInitialized = true;
  G4RunManager::Initialize();
}

Instance()

RunManager & Instance ( )

static

Static method to get a reference to the RunManager instance.

Returns

A reference to an instance of this class.

Definition at line 29 of file RunManager.cc.

{
  if (!m_instance) m_instance = new RunManager();
  return *m_instance;
}

processEvent()

void processEvent

(

int

evtNumber

)

Process a single event in Geant4.

Parameters

evtNumber

The current number of the event.

Definition at line 67 of file RunManager.cc.

{
  //Geant4 simulation
  currentEvent = GenerateEvent(evtNumber);
  eventManager->ProcessOneEvent(currentEvent);
  AnalyzeEvent(currentEvent);
  UpdateScoring();
  StackPreviousEvent(currentEvent);
  currentEvent = NULL;
}

Friends And Related Function Documentation

SingletonDestroyer

friend class SingletonDestroyer

friend

Definition at line 103 of file RunManager.h.

Member Data Documentation

m_AssemblyVolumes

std::vector<G4AssemblyVolume*> m_AssemblyVolumes

private

Vector of pointers to G4AssemblyVolumes.

Definition at line 87 of file RunManager.h.

m_instance

RunManager * m_instance = NULL

staticprivate

Pointer that saves the instance of this class.

Definition at line 84 of file RunManager.h.

m_randomEngine

RandomEngine* m_randomEngine

private

Pointer to RandomEngine to avoid memory leak by creating it in the constructor and deleting it in the destructor.

Definition at line 90 of file RunManager.h.

---

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

• simulation/kernel/include/RunManager.h
• simulation/kernel/src/RunManager.cc