Implementation of the TVirtualMCStack interface. More...

#include <Ex03dMCStack.h>

Inheritance diagram for Ex03dMCStack:

Public Member Functions
	Ex03dMCStack (Int_t size)
	Ex03dMCStack ()
virtual	~Ex03dMCStack ()
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 ()
void	Register ()
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
std::vector< TParticle > *	fParticles
	< The stack of particles (transient)
std::vector< Ex03dParticle > *	fExParticles
	< The vector of particle (persistent)
Int_t	fCurrentTrack { -1 }
	< The vector of particle (persistent)
Int_t	fNPrimary { 0 }
	< The current track number

Detailed Description

Implementation of the TVirtualMCStack interface.

A variant of the Ex03MCStack class updated for RNTuple output.

Date: 07/07/2026

Author: Radoslaw Karabowicz; GSI

Definition at line 37 of file Ex03dMCStack.h.

Constructor & Destructor Documentation

◆ Ex03dMCStack() [1/2]

Ex03dMCStack::Ex03dMCStack ( Int_t size )

Standard constructor

Parameters

size	The stack size

Definition at line 32 of file Ex03dMCStack.cxx.

{
  /// Standard constructor
  /// \param size  The stack size
}

◆ Ex03dMCStack() [2/2]

Ex03dMCStack::Ex03dMCStack ( )

Default constructor

Definition at line 39 of file Ex03dMCStack.cxx.

{
  /// Default constructor
}

◆ ~Ex03dMCStack()

Ex03dMCStack::~Ex03dMCStack ( )

virtual

Destructor

Definition at line 45 of file Ex03dMCStack.cxx.

{
  /// Destructor
 
  delete fParticles;
}

Member Function Documentation

◆ PushTrack()

void Ex03dMCStack::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

Definition at line 61 of file Ex03dMCStack.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;
 
  Int_t trackId = GetNtrack();
  fParticles->push_back(TParticle(pdg, is, parent, trackId, kFirstDaughter,
    kLastDaughter, px, py, pz, e, vx, vy, vz, tof));
  auto particle = &fParticles->back();
 
  particle->SetPolarisation(polx, poly, polz);
  particle->SetWeight(weight);
  particle->SetUniqueID(mech);
 
  fExParticles->push_back(Ex03dParticle(pdg, is, parent, trackId,
    kFirstDaughter, kLastDaughter, px, py, pz, e, vx, vy, vz, tof));
  auto exParticle = &fExParticles->back();
 
  exParticle->SetPolarisation(polx, poly, polz);
  exParticle->SetWeight(weight);
 
  if (parent < 0) fNPrimary++;
 
  if (toBeDone) fStack.push(particle);
 
  ntr = GetNtrack() - 1;
}

◆ PopNextTrack()

TParticle * Ex03dMCStack::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 116 of file Ex03dMCStack.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 * Ex03dMCStack::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 137 of file Ex03dMCStack.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 &(*fParticles)[i];
}

◆ Print()

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

virtual

Print info for all particles.

Definition at line 150 of file Ex03dMCStack.cxx.

{
  /// Print info for all particles.
 
  cout << "Ex03dMCStack 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 Ex03dMCStack::Reset ( )

Delete contained particles, reset particles array and stack.

Definition at line 162 of file Ex03dMCStack.cxx.

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

◆ Register()

void Ex03dMCStack::Register ( )

Definition at line 55 of file Ex03dMCStack.cxx.

{
  TMCRootManager::Instance()->Register("particles", fExParticles);
}

◆ SetCurrentTrack()

void Ex03dMCStack::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 Ex03dMCStack.cxx.

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

◆ GetNtrack()

Int_t Ex03dMCStack::GetNtrack ( ) const

virtual

Returns: The total number of all tracks.

Definition at line 182 of file Ex03dMCStack.cxx.

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

◆ GetNprimary()

Int_t Ex03dMCStack::GetNprimary ( ) const

virtual

Returns: The total number of primary tracks.

Definition at line 189 of file Ex03dMCStack.cxx.

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

◆ GetCurrentTrack()

TParticle * Ex03dMCStack::GetCurrentTrack ( ) const

virtual

Returns: The current track particle

Definition at line 197 of file Ex03dMCStack.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 Ex03dMCStack::GetCurrentTrackNumber ( ) const

virtual

Returns: The current track number

Definition at line 210 of file Ex03dMCStack.cxx.

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

◆ GetCurrentParentTrackNumber()

Int_t Ex03dMCStack::GetCurrentParentTrackNumber ( ) const

virtual

Returns: The current track parent ID.

Definition at line 218 of file Ex03dMCStack.cxx.

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

◆ GetParticle()

TParticle * Ex03dMCStack::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 231 of file Ex03dMCStack.cxx.

{
  /// \return   The \em id -th particle in fParticles
  /// \param id The index of the particle to be returned
 
  if (id < 0 || id >= fParticles->size())
    Fatal("GetParticle", "Index out of range");
 
  return &(*fParticles)[id];
}

Member Data Documentation

◆ fStack

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

private

Definition at line 69 of file Ex03dMCStack.h.

◆ fParticles

std::vector<TParticle>* Ex03dMCStack::fParticles

private

Initial value:

{
    new std::vector<TParticle>
  }

< The stack of particles (transient)

Definition at line 70 of file Ex03dMCStack.h.

                                  {
    new std::vector<TParticle>
  }; //! < The vector of particle (persistent)

◆ fExParticles

std::vector<Ex03dParticle>* Ex03dMCStack::fExParticles

private

Initial value:

{
    new std::vector<Ex03dParticle>
  }

< The vector of particle (persistent)

Definition at line 75 of file Ex03dMCStack.h.

                                        {
    new std::vector<Ex03dParticle>
  };                         //! < The vector of particle (persistent)

◆ fCurrentTrack

Int_t Ex03dMCStack::fCurrentTrack { -1 }

private

< The vector of particle (persistent)

Definition at line 78 of file Ex03dMCStack.h.

78{ -1 }; /// < The current track number

◆ fNPrimary

Int_t Ex03dMCStack::fNPrimary { 0 }

private

< The current track number

Definition at line 79 of file Ex03dMCStack.h.

79{ 0 }; /// < The number of primaries

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

examples/E03/E03d/include/Ex03dMCStack.h
examples/E03/E03d/src/Ex03dMCStack.cxx

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Ex03dMCStack() [1/2]

◆ Ex03dMCStack() [2/2]

◆ ~Ex03dMCStack()

Member Function Documentation

◆ PushTrack()

◆ PopNextTrack()

◆ PopPrimaryForTracking()

◆ Print()

◆ Reset()

◆ Register()

◆ SetCurrentTrack()

◆ GetNtrack()

◆ GetNprimary()

◆ GetCurrentTrack()

◆ GetCurrentTrackNumber()

◆ GetCurrentParentTrackNumber()

◆ GetParticle()

Member Data Documentation

◆ fStack

◆ fParticles

◆ fExParticles

◆ fCurrentTrack

◆ fNPrimary