Ex03cMCStack.cxx

Go to the documentation of this file.

//------------------------------------------------
// The Virtual Monte Carlo examples
// Copyright (C) 2014 - 2018 Ivana Hrivnacova
// All rights reserved.
//
// For the licensing terms see geant4_vmc/LICENSE.
// Contact: root-vmc@cern.ch
//-------------------------------------------------
 
/// \file Ex03cMCStack.cxx
/// \brief Implementation of the Ex03cMCStack class
///
/// Geant4 ExampleN03 adapted to Virtual Monte Carlo
///
/// \date 21/08/2019
/// \author Benedikt Volkel, CERN
 
#include <Riostream.h>
#include <TClonesArray.h>
#include <TError.h>
#include <TParticle.h>
 
#include "TMCManager.h"
 
#include "Ex03cMCStack.h"
 
using namespace std;
 
/// \cond CLASSIMP
ClassImp(Ex03cMCStack)
  /// \endcond
 
  //_____________________________________________________________________________
  Ex03cMCStack::Ex03cMCStack(Int_t size)
  : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Standard constructor
  /// \param size  The stack size
 
  fParticles = new TClonesArray("TParticle", size);
}
 
//_____________________________________________________________________________
Ex03cMCStack::Ex03cMCStack() : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Default constructor
}
 
//_____________________________________________________________________________
Ex03cMCStack::~Ex03cMCStack()
{
  /// Destructor
 
  if (fParticles) fParticles->Delete();
  delete fParticles;
}
 
// private methods
 
// public methods
 
//_____________________________________________________________________________
void Ex03cMCStack::PushTrack(Int_t toBeDone, Int_t parent, Int_t pdg,
  Double_t px, Double_t py, Double_t pz, Double_t e, Double_t vx, Double_t vy,
  Double_t vz, Double_t tof, Double_t polx, Double_t poly, Double_t polz,
  TMCProcess mech, Int_t& ntr, Double_t weight, Int_t is)
{
  /// Create a new particle and push into stack;
  /// adds it to the particles array (fParticles) and if not done to the
  /// stack (fStack).
  /// Use TParticle::fMother[1] to store Track ID.
  /// \param toBeDone  1 if particles should go to tracking, 0 otherwise
  /// \param parent    number of the parent track, -1 if track is primary
  /// \param pdg       PDG encoding
  /// \param px        particle momentum - x component [GeV/c]
  /// \param py        particle momentum - y component [GeV/c]
  /// \param pz        particle momentum - z component [GeV/c]
  /// \param e         total energy [GeV]
  /// \param vx        position - x component [cm]
  /// \param vy        position - y component  [cm]
  /// \param vz        position - z component  [cm]
  /// \param tof       time of flight [s]
  /// \param polx      polarization - x component
  /// \param poly      polarization - y component
  /// \param polz      polarization - z component
  /// \param mech      creator process VMC code
  /// \param ntr       track number (is filled by the stack
  /// \param weight    particle weight
  /// \param is        generation status code
 
  const Int_t kFirstDaughter = -1;
  const Int_t kLastDaughter = -1;
 
  TClonesArray& particlesRef = *fParticles;
  Int_t trackId = GetNtrack();
  TParticle* particle = new (particlesRef[trackId]) TParticle(pdg, is, parent,
    trackId, kFirstDaughter, kLastDaughter, px, py, pz, e, vx, vy, vz, tof);
 
  particle->SetPolarisation(polx, poly, polz);
  particle->SetWeight(weight);
  particle->SetUniqueID(mech);
 
  if (parent < 0) fNPrimary++;
 
  if (toBeDone) fStack.push(particle);
 
  ntr = GetNtrack() - 1;
 
  /// Forward to the TMCManager in case of multi-run
  TMCManager* mgr = TMCManager::Instance();
  if (mgr) {
    mgr->ForwardTrack(toBeDone, ntr, parent, particle);
  }
}
 
//_____________________________________________________________________________
TParticle* Ex03cMCStack::PopNextTrack(Int_t& itrack)
{
  /// Get next particle for tracking from the stack.
  /// \return       The popped particle object
  /// \param track  The index of the popped track
 
  itrack = -1;
  if (fStack.empty()) return 0;
 
  TParticle* particle = fStack.top();
  fStack.pop();
 
  if (!particle) return 0;
 
  fCurrentTrack = particle->GetSecondMother();
  itrack = fCurrentTrack;
 
  return particle;
}
 
//_____________________________________________________________________________
TParticle* Ex03cMCStack::PopPrimaryForTracking(Int_t i)
{
  /// Return \em i -th particle in fParticles.
  /// \return   The popped primary particle object
  /// \param i  The index of primary particle to be popped
 
  if (i < 0 || i >= fNPrimary)
    Fatal("GetPrimaryForTracking", "Index out of range");
 
  return (TParticle*)fParticles->At(i);
}
 
//_____________________________________________________________________________
void Ex03cMCStack::Print(Option_t* /*option*/) const
{
  /// Print info for all particles.
 
  cout << "Ex03cMCStack Info  " << endl;
  cout << "Total number of particles:   " << GetNtrack() << endl;
  cout << "Number of primary particles: " << GetNprimary() << endl;
 
  for (Int_t i = 0; i < GetNtrack(); i++) GetParticle(i)->Print();
}
 
//_____________________________________________________________________________
void Ex03cMCStack::Reset()
{
  /// Delete contained particles, reset particles array and stack.
 
  fCurrentTrack = -1;
  fNPrimary = 0;
  fParticles->Clear();
}
 
//_____________________________________________________________________________
void Ex03cMCStack::SetCurrentTrack(Int_t track)
{
  /// Set the current track number to a given value.
  /// \param  track The current track number
 
  fCurrentTrack = track;
}
 
//_____________________________________________________________________________
Int_t Ex03cMCStack::GetNtrack() const
{
  /// \return  The total number of all tracks.
 
  return fParticles->GetEntriesFast();
}
 
//_____________________________________________________________________________
Int_t Ex03cMCStack::GetNprimary() const
{
  /// \return  The total number of primary tracks.
 
  return fNPrimary;
}
 
//_____________________________________________________________________________
TParticle* Ex03cMCStack::GetCurrentTrack() const
{
  /// \return  The current track particle
 
  TParticle* current = GetParticle(fCurrentTrack);
 
  if (!current)
    Warning("GetCurrentTrack", "Current track not found in the stack");
 
  return current;
}
 
//_____________________________________________________________________________
Int_t Ex03cMCStack::GetCurrentTrackNumber() const
{
  /// \return  The current track number
 
  return fCurrentTrack;
}
 
//_____________________________________________________________________________
Int_t Ex03cMCStack::GetCurrentParentTrackNumber() const
{
  /// \return  The current track parent ID.
 
  TParticle* current = GetCurrentTrack();
 
  if (current)
    return current->GetFirstMother();
  else
    return -1;
}
 
//_____________________________________________________________________________
TParticle* Ex03cMCStack::GetParticle(Int_t id) const
{
  /// \return   The \em id -th particle in fParticles
  /// \param id The index of the particle to be returned
 
  if (id < 0 || id >= fParticles->GetEntriesFast())
    Fatal("GetParticle", "Index out of range");
 
  return (TParticle*)fParticles->At(id);
}