Ex03cMCStack Class Reference

Implementation of the TVirtualMCStack interface. More...

#include <Ex03cMCStack.h>

Inheritance diagram for Ex03cMCStack:

Public Member Functions
	Ex03cMCStack (Int_t size)
	Ex03cMCStack ()
virtual	~Ex03cMCStack ()
virtual void	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)
virtual TParticle *	PopNextTrack (Int_t &track)
virtual TParticle *	PopPrimaryForTracking (Int_t i)
virtual void	Print (Option_t *option="") const
void	Reset ()
virtual void	SetCurrentTrack (Int_t track)
virtual Int_t	GetNtrack () const
virtual Int_t	GetNprimary () const
virtual TParticle *	GetCurrentTrack () const
virtual Int_t	GetCurrentTrackNumber () const
virtual Int_t	GetCurrentParentTrackNumber () const
TParticle *	GetParticle (Int_t id) const

Private Attributes
std::stack< TParticle * >	fStack
	The stack of particles (transient)
TClonesArray *	fParticles
	The array of particle (persistent)
Int_t	fCurrentTrack
	The current track number.
Int_t	fNPrimary
	The number of primaries.

Detailed Description

Implementation of the TVirtualMCStack interface.

A variant of the Ex03CalorimeterSD class updated for multiple engine runs.

Date

21/08/2019

Author

Benedikt Volkel, CERN

Definition at line 36 of file Ex03cMCStack.h.

Constructor & Destructor Documentation

Ex03cMCStack() [1/2]

Ex03cMCStack::Ex03cMCStack

(

Int_t

size

)

Standard constructor

Parameters

size	The stack size

Definition at line 34 of file Ex03cMCStack.cxx.

  : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Standard constructor
  /// \param size  The stack size
 
  fParticles = new TClonesArray("TParticle", size);
}

Ex03cMCStack() [2/2]

Ex03cMCStack::Ex03cMCStack

(

)

Default constructor

Definition at line 44 of file Ex03cMCStack.cxx.

                           : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Default constructor
}

~Ex03cMCStack()

Ex03cMCStack::~Ex03cMCStack ( )

virtual

Destructor

Definition at line 50 of file Ex03cMCStack.cxx.

{
  /// Destructor
 
  if (fParticles) fParticles->Delete();
  delete fParticles;
}

Member Function Documentation

PushTrack()

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 )

virtual

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.

Parameters

toBeDone	1 if particles should go to tracking, 0 otherwise
parent	number of the parent track, -1 if track is primary
pdg	PDG encoding
px	particle momentum - x component [GeV/c]
py	particle momentum - y component [GeV/c]
pz	particle momentum - z component [GeV/c]
e	total energy [GeV]
vx	position - x component [cm]
vy	position - y component [cm]
vz	position - z component [cm]
tof	time of flight [s]
polx	polarization - x component
poly	polarization - y component
polz	polarization - z component
mech	creator process VMC code
ntr	track number (is filled by the stack
weight	particle weight
is	generation status code

Forward to the TMCManager in case of multi-run

Definition at line 63 of file Ex03cMCStack.cxx.

{
  /// 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);
  }
}

PopNextTrack()

TParticle * Ex03cMCStack::PopNextTrack ( Int_t & track )

virtual

Get next particle for tracking from the stack.

Returns

The popped particle object

Parameters

track

The index of the popped track

Definition at line 117 of file Ex03cMCStack.cxx.

{
  /// 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;
}

PopPrimaryForTracking()

TParticle * Ex03cMCStack::PopPrimaryForTracking ( Int_t i )

virtual

Return i -th particle in fParticles.

Returns

The popped primary particle object

Parameters

i	The index of primary particle to be popped

Definition at line 138 of file Ex03cMCStack.cxx.

{
  /// 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);
}

Print()

void Ex03cMCStack::Print ( Option_t * option = "" ) const

virtual

Print info for all particles.

Definition at line 151 of file Ex03cMCStack.cxx.

{
  /// 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();
}

Reset()

void Ex03cMCStack::Reset

(

)

Delete contained particles, reset particles array and stack.

Definition at line 163 of file Ex03cMCStack.cxx.

{
  /// Delete contained particles, reset particles array and stack.
 
  fCurrentTrack = -1;
  fNPrimary = 0;
  fParticles->Clear();
}

SetCurrentTrack()

void Ex03cMCStack::SetCurrentTrack ( Int_t track )

virtual

Set the current track number to a given value.

Parameters

track

The current track number

Definition at line 173 of file Ex03cMCStack.cxx.

{
  /// Set the current track number to a given value.
  /// \param  track The current track number
 
  fCurrentTrack = track;
}

GetNtrack()

Int_t Ex03cMCStack::GetNtrack ( ) const

virtual

Returns

The total number of all tracks.

Definition at line 182 of file Ex03cMCStack.cxx.

{
  /// \return  The total number of all tracks.
 
  return fParticles->GetEntriesFast();
}

GetNprimary()

Int_t Ex03cMCStack::GetNprimary ( ) const

virtual

Returns

The total number of primary tracks.

Definition at line 190 of file Ex03cMCStack.cxx.

{
  /// \return  The total number of primary tracks.
 
  return fNPrimary;
}

GetCurrentTrack()

TParticle * Ex03cMCStack::GetCurrentTrack ( ) const

virtual

Returns

The current track particle

Definition at line 198 of file Ex03cMCStack.cxx.

{
  /// \return  The current track particle
 
  TParticle* current = GetParticle(fCurrentTrack);
 
  if (!current)
    Warning("GetCurrentTrack", "Current track not found in the stack");
 
  return current;
}

GetCurrentTrackNumber()

Int_t Ex03cMCStack::GetCurrentTrackNumber ( ) const

virtual

Returns

The current track number

Definition at line 211 of file Ex03cMCStack.cxx.

{
  /// \return  The current track number
 
  return fCurrentTrack;
}

GetCurrentParentTrackNumber()

Int_t Ex03cMCStack::GetCurrentParentTrackNumber ( ) const

virtual

Returns

The current track parent ID.

Definition at line 219 of file Ex03cMCStack.cxx.

{
  /// \return  The current track parent ID.
 
  TParticle* current = GetCurrentTrack();
 
  if (current)
    return current->GetFirstMother();
  else
    return -1;
}

GetParticle()

TParticle * Ex03cMCStack::GetParticle

(

Int_t

id

)

const

Returns

The id -th particle in fParticles

Parameters

id	The index of the particle to be returned

Definition at line 232 of file Ex03cMCStack.cxx.

{
  /// \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);
}

Member Data Documentation

fStack

std::stack<TParticle*> Ex03cMCStack::fStack

private

The stack of particles (transient)

Definition at line 66 of file Ex03cMCStack.h.

fParticles

TClonesArray* Ex03cMCStack::fParticles

private

The array of particle (persistent)

Definition at line 67 of file Ex03cMCStack.h.

fCurrentTrack

Int_t Ex03cMCStack::fCurrentTrack

private

The current track number.

Definition at line 68 of file Ex03cMCStack.h.

fNPrimary

Int_t Ex03cMCStack::fNPrimary

private

The number of primaries.

Definition at line 69 of file Ex03cMCStack.h.

---

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

• examples/E03/E03c/include/Ex03cMCStack.h
• examples/E03/E03c/src/Ex03cMCStack.cxx