Implementation of the TVirtualMCApplication. More...

#include <MCApplication.h>

Inheritance diagram for VMC::TR::MCApplication:

Public Member Functions
	MCApplication (const char name, const char title)

	MCApplication ()

virtual	~MCApplication ()

void	InitMC (const char *setup)

void	RunMC (Int_t nofEvents)

void	FinishRun ()

virtual TVirtualMCApplication *	CloneForWorker () const

virtual void	InitOnWorker ()

virtual void	FinishRunOnWorker ()

virtual void	ConstructGeometry ()

virtual void	InitGeometry ()

virtual void	GeneratePrimaries ()

virtual void	BeginEvent ()

virtual void	BeginPrimary ()

virtual void	PreTrack ()

virtual void	Stepping ()

virtual void	PostTrack ()

virtual void	FinishPrimary ()

virtual void	FinishEvent ()

void	SetPrintModulo (Int_t value)

void	SetVerboseLevel (Int_t verboseLevel)

void	SetControls (Bool_t isConstrols)

void	SetField (Double_t bz)

DetectorConstruction *	GetDetectorConstruction () const

SensitiveDetector *	GetSensitiveDetector () const

PrimaryGenerator *	GetPrimaryGenerator () const

void	SetOldGeometry (Bool_t oldGeometry=kTRUE)

Private Member Functions
	MCApplication (const MCApplication &origin)

void	RegisterStack () const

void	BookHisto () const

Private Attributes
TMCRootManager *	fRootManager
	Root manager.

Int_t	fPrintModulo
	The event modulus number to be printed.

Int_t	fEventNo
	Event counter.

TMCVerbose	fVerbose
	VMC verbose helper.

Ex03MCStack *	fStack
	VMC stack.

DetectorConstruction *	fDetConstruction
	Dector construction.

SensitiveDetector *	fSensitiveDetector
	Absorber SD.

PrimaryGenerator *	fPrimaryGenerator
	Primary generator.

TGeoUniformMagField *	fMagField
	Magnetic field.

Bool_t	fOldGeometry
	Option for geometry definition.

Bool_t	fIsControls
	Option to activate special controls.

Bool_t	fIsMaster
	If is on master thread.

Detailed Description

Implementation of the TVirtualMCApplication.

Date: 18/12/2015

Author: I. Hrivnacova; IPN, Orsay

Definition at line 44 of file MCApplication.h.

Constructor & Destructor Documentation

◆ MCApplication() [1/3]

VMC::TR::MCApplication::MCApplication	(	const char *	name,
		const char *	title )

Standard constructor

Parameters

name	The MC application name
title	The MC application description

Definition at line 51 of file MCApplication.cxx.

    : TVirtualMCApplication(name, title),
      fRootManager(0),
      fPrintModulo(1),
      fEventNo(0),
      fVerbose(0),
      fStack(0),
      fDetConstruction(0),
      fSensitiveDetector(0),
      fPrimaryGenerator(0),
      fMagField(0),
      fOldGeometry(kFALSE),
      fIsControls(kFALSE),
      fIsMaster(kTRUE)
  {
    /// Standard constructor
    /// \param name   The MC application name
    /// \param title  The MC application description
 
    // Create a user stack
    fStack = new Ex03MCStack(1000);
 
    // Create detector construction
    fDetConstruction = new DetectorConstruction();
 
    // Create a calorimeter SD
    fSensitiveDetector = new SensitiveDetector("Absorber");
 
    // Create a primary generator
    fPrimaryGenerator = new PrimaryGenerator(fStack);
 
    // Constant magnetic field (in kiloGauss)
    fMagField = new TGeoUniformMagField();
  }

◆ MCApplication() [2/3]

VMC::TR::MCApplication::MCApplication ( )

Default constructor

Definition at line 121 of file MCApplication.cxx.

    : TVirtualMCApplication(),
      fRootManager(0),
      fPrintModulo(1),
      fEventNo(0),
      fStack(0),
      fDetConstruction(0),
      fSensitiveDetector(0),
      fPrimaryGenerator(0),
      fMagField(0),
      fOldGeometry(kFALSE),
      fIsControls(kFALSE),
      fIsMaster(kTRUE)
  {
    /// Default constructor
  }

◆ ~MCApplication()

VMC::TR::MCApplication::~MCApplication ( )

virtual

Destructor

Definition at line 139 of file MCApplication.cxx.

  {
    /// Destructor
 
    // cout << "MCApplication::~MCApplication " << this << endl;
 
    delete fRootManager;
    delete fStack;
    if (fIsMaster) delete fDetConstruction;
    delete fSensitiveDetector;
    delete fPrimaryGenerator;
    delete fMagField;
    delete gMC;
 
    // cout << "Done MCApplication::~MCApplication " << this << endl;
  }

◆ MCApplication() [3/3]

VMC::TR::MCApplication::MCApplication ( const MCApplication & origin )

private

Copy constructor for cloning application on workers (in multithreading mode)

Parameters

origin The source MC application

Definition at line 87 of file MCApplication.cxx.

    : TVirtualMCApplication(origin.GetName(), origin.GetTitle()),
      fRootManager(0),
      fPrintModulo(origin.fPrintModulo),
      fEventNo(0),
      fVerbose(origin.fVerbose),
      fStack(0),
      fDetConstruction(origin.fDetConstruction),
      fSensitiveDetector(0),
      fPrimaryGenerator(0),
      fMagField(0),
      fOldGeometry(origin.fOldGeometry),
      fIsMaster(kFALSE)
  {
    /// Copy constructor for cloning application on workers (in multithreading
    /// mode) \param origin   The source MC application
 
    // Create new user stack
    fStack = new Ex03MCStack(1000);
 
    // Create a calorimeter SD
    fSensitiveDetector = new SensitiveDetector(*(origin.fSensitiveDetector));
 
    // Create a primary generator
    fPrimaryGenerator =
      new PrimaryGenerator(*(origin.fPrimaryGenerator), fStack);
 
    // Constant magnetic field (in kiloGauss)
    fMagField = new TGeoUniformMagField(origin.fMagField->GetFieldValue()[0],
      origin.fMagField->GetFieldValue()[1],
      origin.fMagField->GetFieldValue()[2]);
  }

Member Function Documentation

◆ InitMC()

void VMC::TR::MCApplication::InitMC ( const char * setup )

Initialize MC. The selection of the concrete MC is done in the macro.

Parameters

setup The name of the configuration macro

Definition at line 188 of file MCApplication.cxx.

  {
    /// Initialize MC.
    /// The selection of the concrete MC is done in the macro.
    /// \param setup The name of the configuration macro
 
    fVerbose.InitMC();
 
    if (TString(setup) != "") {
      gROOT->LoadMacro(setup);
      gInterpreter->ProcessLine("Config()");
      if (!gMC) {
        Fatal(
          "InitMC", "Processing Config() has failed. (No MC is instantiated.)");
      }
    }
 
// MT support available from root v 5.34/18
#if ROOT_VERSION_CODE >= 336402
    // Create Root manager
    if (!gMC->IsMT()) {
      fRootManager = new TMCRootManager(GetName(), TMCRootManager::kWrite);
      // fRootManager->SetDebug(true);
    }
#else
    // Create Root manager
    fRootManager = new TMCRootManager(GetName(), TMCRootManager::kWrite);
    // fRootManager->SetDebug(true);
#endif
    // Cretae histograms
    BookHisto();
 
    gMC->SetStack(fStack);
    gMC->SetMagField(fMagField);
    gMC->Init();
    gMC->BuildPhysics();
 
    RegisterStack();
  }

◆ RunMC()

void VMC::TR::MCApplication::RunMC ( Int_t nofEvents )

Run MC.

Parameters

nofEvents Number of events to be processed

Definition at line 229 of file MCApplication.cxx.

  {
    /// Run MC.
    /// \param nofEvents Number of events to be processed
 
    fVerbose.RunMC(nofEvents);
 
    gMC->ProcessRun(nofEvents);
    FinishRun();
  }

◆ FinishRun()

void VMC::TR::MCApplication::FinishRun ( )

Finish MC run.

Definition at line 241 of file MCApplication.cxx.

  {
    /// Finish MC run.
 
    fVerbose.FinishRun();
    // cout << "MCApplication::FinishRun: " << endl;
 
    // print run statisctics
    cout << " ================== run summary =====================" << endl;
    cout << " End of Run TotNbofEvents = " << fEventNo << endl;
 
    cout << " Mean energy deposit in absorber = " << fHistograms[0]->GetMean()
         << " +-" << fHistograms[0]->GetRMS() << "  MeV " << endl;
 
    cout << " Total number of XTR gammas = " << fHistograms[1]->GetEntries()
         << endl;
 
    cout << " Total number of all gammas = " << fHistograms[2]->GetEntries()
         << endl;
 
    if (fRootManager) {
      fRootManager->WriteAll();
      fRootManager->Close();
    }
  }

◆ CloneForWorker()

TVirtualMCApplication * VMC::TR::MCApplication::CloneForWorker ( ) const

virtual

Definition at line 268 of file MCApplication.cxx.

  {
    return new MCApplication(*this);
  }

◆ InitOnWorker()

void VMC::TR::MCApplication::InitOnWorker ( )

virtual

Definition at line 274 of file MCApplication.cxx.

  {
    // cout << "MCApplication::InitForWorker " << this << endl;
 
    // Create Root manager
    fRootManager = new TMCRootManager(GetName(), TMCRootManager::kWrite);
    // fRootManager->SetDebug(true);
 
    // Set data to MC
    gMC->SetStack(fStack);
    gMC->SetMagField(fMagField);
 
    RegisterStack();
  }

◆ FinishRunOnWorker()

void VMC::TR::MCApplication::FinishRunOnWorker ( )

virtual

Definition at line 290 of file MCApplication.cxx.

  {
    // cout << "MCApplication::FinishWorkerRun: " << endl;
    if (fRootManager) {
      fRootManager->WriteAll();
      fRootManager->Close();
    }
  }

◆ ConstructGeometry()

void VMC::TR::MCApplication::ConstructGeometry ( )

virtual

Construct geometry using detector contruction class. The detector contruction class is using TGeo functions or TVirtualMC functions (if oldGeometry is selected)

Definition at line 300 of file MCApplication.cxx.

  {
    /// Construct geometry using detector contruction class.
    /// The detector contruction class is using TGeo functions or
    /// TVirtualMC functions (if oldGeometry is selected)
 
    fVerbose.ConstructGeometry();
 
    fDetConstruction->ConstructGeometry();
  }

◆ InitGeometry()

void VMC::TR::MCApplication::InitGeometry ( )

virtual

Initialize geometry

Definition at line 312 of file MCApplication.cxx.

  {
    /// Initialize geometry
 
    fVerbose.InitGeometry();
 
    fSensitiveDetector->Initialize();
  }

◆ GeneratePrimaries()

void VMC::TR::MCApplication::GeneratePrimaries ( )

virtual

Fill the user stack (derived from TVirtualMCStack) with primary particles.

Definition at line 322 of file MCApplication.cxx.

  {
    /// Fill the user stack (derived from TVirtualMCStack) with primary
    /// particles.
 
    fVerbose.GeneratePrimaries();
 
    fPrimaryGenerator->GeneratePrimaries();
  }

◆ BeginEvent()

void VMC::TR::MCApplication::BeginEvent ( )

virtual

User actions at beginning of event

Definition at line 333 of file MCApplication.cxx.

  {
    /// User actions at beginning of event
 
    fVerbose.BeginEvent();
 
    // Clear TGeo tracks (if filled)
    if (TString(gMC->GetName()) == "TGeant3TGeo" &&
        gGeoManager->GetListOfTracks() && gGeoManager->GetTrack(0) &&
        ((TVirtualGeoTrack*)gGeoManager->GetTrack(0))->HasPoints()) {
 
      gGeoManager->ClearTracks();
      // if (gPad) gPad->Clear();
    }
 
    fEventNo++;
    if (fEventNo % fPrintModulo == 0) {
      cout << "\n---> Begin of event: " << fEventNo << endl;
    }
  }

◆ BeginPrimary()

void VMC::TR::MCApplication::BeginPrimary ( )

virtual

User actions at beginning of a primary track.

Definition at line 355 of file MCApplication.cxx.

  {
    /// User actions at beginning of a primary track.
 
    fVerbose.BeginPrimary();
  }

◆ PreTrack()

void VMC::TR::MCApplication::PreTrack ( )

virtual

User actions at beginning of each track. Fill spectra.

Definition at line 363 of file MCApplication.cxx.

  {
    /// User actions at beginning of each track.
    /// Fill spectra.
 
    fVerbose.PreTrack();
 
    // Gamma
    if (gMC->TrackPid() == kGamma) {
      // XTR gammas
      Int_t creatorProcess = fStack->GetCurrentTrack()->GetUniqueID();
 
// Available since 6.07/03 and 5.34/35
// kpTransitionRadiation = 49
#if ((ROOT_VERSION_CODE >= ROOT_VERSION(6, 7, 3)) ||  \
     ((ROOT_VERSION_CODE <= ROOT_VERSION(6, 0, 0)) && \
       (ROOT_VERSION_CODE >= ROOT_VERSION(5, 34, 35))))
      if (creatorProcess == kPTransitionRadiation) {
#else
      if (creatorProcess == kPNull) {
#endif
        fHistograms[1]->Fill(gMC->Etot() * 1e+03);
      }
      fHistograms[2]->Fill(gMC->Etot() * 1e+03);
    }
 
    // Secondary e-
    if (gMC->TrackPid() == kElectron &&
        fStack->GetCurrentParentTrackNumber() != -1) {
 
      fHistograms[3]->Fill((gMC->Etot() - gMC->TrackMass()) * 1e+03);
    }
  }

◆ Stepping()

void VMC::TR::MCApplication::Stepping ( )

virtual

User actions at each step

Definition at line 398 of file MCApplication.cxx.

  {
    /// User actions at each step
 
    // Work around for Fluka VMC, which does not call
    // MCApplication::PreTrack()
    //
    // cout << "MCApplication::Stepping" << this << endl;
    static Int_t trackId = 0;
    if (TString(gMC->GetName()) == "TFluka" &&
        gMC->GetStack()->GetCurrentTrackNumber() != trackId) {
      fVerbose.PreTrack();
      trackId = gMC->GetStack()->GetCurrentTrackNumber();
    }
 
    fVerbose.Stepping();
 
    fSensitiveDetector->ProcessHits();
  }

◆ PostTrack()

void VMC::TR::MCApplication::PostTrack ( )

virtual

User actions after finishing of each track

Definition at line 419 of file MCApplication.cxx.

  {
    /// User actions after finishing of each track
 
    fVerbose.PostTrack();
  }

◆ FinishPrimary()

void VMC::TR::MCApplication::FinishPrimary ( )

virtual

User actions after finishing of a primary track

Definition at line 427 of file MCApplication.cxx.

  {
    /// User actions after finishing of a primary track
 
    fVerbose.FinishPrimary();
  }

◆ FinishEvent()

void VMC::TR::MCApplication::FinishEvent ( )

virtual

User actions after finishing of an event

Definition at line 435 of file MCApplication.cxx.

  {
    /// User actions after finishing of an event
 
    fVerbose.FinishEvent();
 
    // Geant3 + TGeo
    // (use TGeo functions for visualization)
    // if ( TString(gMC->GetName()) == "TGeant3TGeo") {
 
    //    // Draw volume
    //    gGeoManager->SetVisOption(0);
    //    gGeoManager->SetTopVisible();
    //    gGeoManager->GetTopVolume()->Draw();
 
    //    // Draw tracks (if filled)
    //    // Available when this feature is activated via
    //    // gMC->SetCollectTracks(kTRUE);
    //    if ( gGeoManager->GetListOfTracks() &&
    //         gGeoManager->GetTrack(0) &&
    //       ((TVirtualGeoTrack*)gGeoManager->GetTrack(0))->HasPoints() ) {
 
    //      gGeoManager->DrawTracks("/*");  // this means all tracks
    //   }
    // }
 
    // Fill Edep histogram in MeV
    // cout << "Filling in h0 " <<
    // fSensitiveDetector->GetHit(0)->GetEdep()*1e+03 << endl;
    fHistograms[0]->Fill(fSensitiveDetector->GetEdep() * 1e+03);
 
    fRootManager->Fill();
 
    if (fEventNo % fPrintModulo == 0) {
      fSensitiveDetector->Print();
    }
 
    fSensitiveDetector->EndOfEvent();
    fStack->Reset();
  }

◆ SetPrintModulo()

void VMC::TR::MCApplication::SetPrintModulo ( Int_t value )

inline

Set the event modulus number to be printed

Parameters

value The new event modulus number value

Definition at line 112 of file MCApplication.h.

112{ fPrintModulo = value; }

◆ SetVerboseLevel()

void VMC::TR::MCApplication::SetVerboseLevel ( Int_t verboseLevel )

inline

Set verbosity

Parameters

verboseLevel The new verbose level value

Definition at line 116 of file MCApplication.h.

{
  fVerbose.SetLevel(verboseLevel);
}

◆ SetControls()

void VMC::TR::MCApplication::SetControls ( Bool_t isControls )

inline

Switch on/off special process controls

Parameters

isControls If true, special process controls setting is activated

Definition at line 155 of file MCApplication.h.

{
  fIsControls = isControls;
}

◆ SetField()

void VMC::TR::MCApplication::SetField ( Double_t bz )

inline

Definition at line 123 of file MCApplication.h.

{
  fMagField->SetFieldValue(0., 0., bz);
}

◆ GetDetectorConstruction()

DetectorConstruction * VMC::TR::MCApplication::GetDetectorConstruction ( ) const

inline

Returns: The detector construction

Definition at line 129 of file MCApplication.h.

{
  return fDetConstruction;
}

◆ GetSensitiveDetector()

SensitiveDetector * VMC::TR::MCApplication::GetSensitiveDetector ( ) const

inline

Returns: The calorimeter sensitive detector

Definition at line 135 of file MCApplication.h.

{
  return fSensitiveDetector;
}

◆ GetPrimaryGenerator()

PrimaryGenerator * VMC::TR::MCApplication::GetPrimaryGenerator ( ) const

inline

Returns: The primary generator

Definition at line 141 of file MCApplication.h.

{
  return fPrimaryGenerator;
}

◆ SetOldGeometry()

void VMC::TR::MCApplication::SetOldGeometry ( Bool_t oldGeometry = kTRUE )

inline

Switch on/off the old geometry definition (via VMC functions)

Parameters

oldGeometry If true, geometry definition via VMC functions

Definition at line 148 of file MCApplication.h.

{
  fOldGeometry = oldGeometry;
}

◆ RegisterStack()

void VMC::TR::MCApplication::RegisterStack ( ) const

private

Register stack in the Root manager.

Definition at line 161 of file MCApplication.cxx.

  {
    /// Register stack in the Root manager.
 
    if (fRootManager) {
      // cout << "MCApplication::RegisterStack: " << endl;
      fRootManager->Register("stack", "Ex03MCStack", &fStack);
    }
  }

◆ BookHisto()

void VMC::TR::MCApplication::BookHisto ( ) const

private

Create histograms

Definition at line 172 of file MCApplication.cxx.

  {
    /// Create histograms
 
    fHistograms.push_back(new TH1D("1", "Edep", 100, 0., 0.1));
    fHistograms.push_back(new TH1D("2", "XTR Gamma spectrum", 100, 0., 0.1));
    fHistograms.push_back(
      new TH1D("3", "Secondary Gamma spectrum", 100, 0., 0.1));
    fHistograms.push_back(new TH1D("4", "Secondary e- spectrum", 100, 0., 0.1));
  }

Member Data Documentation

◆ fRootManager

TMCRootManager* VMC::TR::MCApplication::fRootManager

mutableprivate

Root manager.

Definition at line 92 of file MCApplication.h.

◆ fPrintModulo

Int_t VMC::TR::MCApplication::fPrintModulo

private

The event modulus number to be printed.

Definition at line 93 of file MCApplication.h.

◆ fEventNo

Int_t VMC::TR::MCApplication::fEventNo

private

Event counter.

Definition at line 94 of file MCApplication.h.

◆ fVerbose

TMCVerbose VMC::TR::MCApplication::fVerbose

private

VMC verbose helper.

Definition at line 95 of file MCApplication.h.

◆ fStack

Ex03MCStack* VMC::TR::MCApplication::fStack

private

VMC stack.

Definition at line 96 of file MCApplication.h.

◆ fDetConstruction

DetectorConstruction* VMC::TR::MCApplication::fDetConstruction

private

Dector construction.

Definition at line 97 of file MCApplication.h.

◆ fSensitiveDetector

SensitiveDetector* VMC::TR::MCApplication::fSensitiveDetector

private

Absorber SD.

Definition at line 98 of file MCApplication.h.

◆ fPrimaryGenerator

PrimaryGenerator* VMC::TR::MCApplication::fPrimaryGenerator

private

Primary generator.

Definition at line 99 of file MCApplication.h.

◆ fMagField

TGeoUniformMagField* VMC::TR::MCApplication::fMagField

private

Magnetic field.

Definition at line 100 of file MCApplication.h.

◆ fOldGeometry

Bool_t VMC::TR::MCApplication::fOldGeometry

private

Option for geometry definition.

Definition at line 101 of file MCApplication.h.

◆ fIsControls

Bool_t VMC::TR::MCApplication::fIsControls

private

Option to activate special controls.

Definition at line 102 of file MCApplication.h.

◆ fIsMaster

Bool_t VMC::TR::MCApplication::fIsMaster

private

If is on master thread.

Definition at line 103 of file MCApplication.h.

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

examples/TR/include/MCApplication.h
examples/TR/src/MCApplication.cxx

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MCApplication() [1/3]

◆ MCApplication() [2/3]

◆ ~MCApplication()

◆ MCApplication() [3/3]

Member Function Documentation

◆ InitMC()

◆ RunMC()

◆ FinishRun()

◆ CloneForWorker()

◆ InitOnWorker()

◆ FinishRunOnWorker()

◆ ConstructGeometry()

◆ InitGeometry()

◆ GeneratePrimaries()

◆ BeginEvent()

◆ BeginPrimary()

◆ PreTrack()

◆ Stepping()

◆ PostTrack()

◆ FinishPrimary()

◆ FinishEvent()

◆ SetPrintModulo()

◆ SetVerboseLevel()

◆ SetControls()

◆ SetField()

◆ GetDetectorConstruction()

◆ GetSensitiveDetector()

◆ GetPrimaryGenerator()

◆ SetOldGeometry()

◆ RegisterStack()

◆ BookHisto()

Member Data Documentation

◆ fRootManager

◆ fPrintModulo

◆ fEventNo

◆ fVerbose

◆ fStack

◆ fDetConstruction

◆ fSensitiveDetector

◆ fPrimaryGenerator

◆ fMagField

◆ fOldGeometry

◆ fIsControls

◆ fIsMaster