Concrete implementation of particles stack used by the TMCManager.

Definition at line 35 of file TMCManagerStack.h.

Public Member Functions
	TMCManagerStack ()
	Default constructor.

virtual	~TMCManagerStack ()=default
	Destructor.

const TGeoBranchArray *	GetCurrentGeoState () const
	Get current particle's geometry status.

Int_t	GetCurrentParentTrackNumber () const override final
	Number of the parent of the current track.

TParticle *	GetCurrentTrack () const override final
	Current track.

Int_t	GetCurrentTrackNumber () const override final
	Current track number.

const TGeoBranchArray *	GetGeoState (Int_t trackId) const
	Get particle's geometry status by trackId.

Int_t	GetNprimary () const override final
	Get number of primaries on current sub-stack.

Int_t	GetNtrack () const override final
	Get number of tracks on current sub-stack.

const TMCParticleStatus *	GetParticleStatus (Int_t trackId) const
	Get TMCParticleStatus by trackId.

Int_t	GetStackedNprimary () const
	Get only the number of currently stacked primaries.

Int_t	GetStackedNtrack () const
	Get only the number of currently stacked tracks.

TParticle *	PopNextTrack (Int_t &itrack) override final
	Pop next track.

TParticle *	PopPrimaryForTracking (Int_t i) override final
	Pop i'th primar, that does not mean that this primariy also has ID==i.

TParticle *	PopPrimaryForTracking (Int_t i, Int_t &itrack)
	Pop i'th primary, that does not mean that this primariy also has ID==i.

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) override final
	This will just forward the call to the fUserStack's PushTrack.

void	SetCurrentTrack (Int_t trackId) override final
	Set the current track id from the outside and forward this to the user's stack.

Public Member Functions inherited from TVirtualMCStack
	TVirtualMCStack ()
	Default constructor.

virtual	~TVirtualMCStack ()
	Destructor.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Private Member Functions
void	ConnectTrackContainers (std::vector< TParticle * > particles, std::vector< std::unique_ptr< TMCParticleStatus > > tracksStatus, TGeoMCBranchArrayContainer branchArrayContainer, Int_t totalNPrimaries, Int_t *totalNTracks)
	Set the pointer to vector with all particles and status.

Bool_t	HasTrackId (Int_t trackId) const
	Check whether track trackId exists.

void	PushPrimaryTrackId (Int_t trackId)
	Push primary id to be processed.

void	PushSecondaryTrackId (Int_t trackId)
	Push secondary id to be processed.

void	ResetInternals ()
	Reset internals, clear engine stack and fParticles and reset buffered values.

void	SetUserStack (TVirtualMCStack *stack)
	Set the user stack.

Private Attributes
TGeoMCBranchArrayContainer *	fBranchArrayContainer
	Storage of TGeoBranchArray pointers.

Int_t	fCurrentTrackId
	Pointer to current track.

std::vector< TParticle * > *	fParticles
	All tracks linked from the TMCManager.

std::vector< std::unique_ptr< TMCParticleStatus > > *	fParticlesStatus
	All TMCParticleStatus linked from the TMCManager.

std::stack< Int_t >	fPrimariesStack
	IDs of primaries to be tracked.

std::stack< Int_t >	fSecondariesStack
	IDs of secondaries to be trackedk.

Int_t *	fTotalNPrimaries
	Number of all primaries ever pushed linked from the TMCManager.

Int_t *	fTotalNTracks
	Number of all tracks ever pushed linked from the TMCManager.

TVirtualMCStack *	fUserStack
	Pointer to user stack for forwarding PushTrack calls.

Friends
class	TMCManager

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

#include <TMCManagerStack.h>

Inheritance diagram for TMCManagerStack:

[legend]

Constructor & Destructor Documentation

◆ TMCManagerStack()

TMCManagerStack::TMCManagerStack ( )

Default constructor.

Definition at line 31 of file TMCManagerStack.cxx.

◆ ~TMCManagerStack()

virtual TMCManagerStack::~TMCManagerStack ( )

virtualdefault

Destructor.

Member Function Documentation

◆ ConnectTrackContainers()

void TMCManagerStack::ConnectTrackContainers	(	std::vector< TParticle * > *	particles,
		std::vector< std::unique_ptr< TMCParticleStatus > > *	tracksStatus,
		TGeoMCBranchArrayContainer *	branchArrayContainer,
		Int_t *	totalNPrimaries,
		Int_t *	totalNTracks
	)

private

Set the pointer to vector with all particles and status.

Connect an engine's stack to the centrally managed vectors.

Definition at line 260 of file TMCManagerStack.cxx.

◆ GetCurrentGeoState()

const TGeoBranchArray * TMCManagerStack::GetCurrentGeoState ( ) const

Get current particle's geometry status.

Definition at line 227 of file TMCManagerStack.cxx.

◆ GetCurrentParentTrackNumber()

Int_t TMCManagerStack::GetCurrentParentTrackNumber ( ) const

finaloverridevirtual

Number of the parent of the current track.

Implements TVirtualMCStack.

Definition at line 176 of file TMCManagerStack.cxx.

◆ GetCurrentTrack()

TParticle * TMCManagerStack::GetCurrentTrack ( ) const

finaloverridevirtual

Current track.

Implements TVirtualMCStack.

Definition at line 151 of file TMCManagerStack.cxx.

◆ GetCurrentTrackNumber()

Int_t TMCManagerStack::GetCurrentTrackNumber ( ) const

finaloverridevirtual

Current track number.

Implements TVirtualMCStack.

Definition at line 166 of file TMCManagerStack.cxx.

◆ GetGeoState()

const TGeoBranchArray * TMCManagerStack::GetGeoState ( Int_t trackId ) const

Get particle's geometry status by trackId.

Definition at line 214 of file TMCManagerStack.cxx.

◆ GetNprimary()

Int_t TMCManagerStack::GetNprimary ( ) const

finaloverridevirtual

Get number of primaries on current sub-stack.

Implements TVirtualMCStack.

Definition at line 131 of file TMCManagerStack.cxx.

◆ GetNtrack()

Int_t TMCManagerStack::GetNtrack ( ) const

finaloverridevirtual

Get number of tracks on current sub-stack.

Implements TVirtualMCStack.

Definition at line 111 of file TMCManagerStack.cxx.

◆ GetParticleStatus()

const TMCParticleStatus * TMCManagerStack::GetParticleStatus ( Int_t trackId ) const

Get TMCParticleStatus by trackId.

Definition at line 201 of file TMCManagerStack.cxx.

◆ GetStackedNprimary()

Int_t TMCManagerStack::GetStackedNprimary ( ) const

Get only the number of currently stacked primaries.

Get number of primaries on current sub-stack.

Definition at line 141 of file TMCManagerStack.cxx.

◆ GetStackedNtrack()

Int_t TMCManagerStack::GetStackedNtrack ( ) const

Get only the number of currently stacked tracks.

Definition at line 121 of file TMCManagerStack.cxx.

◆ HasTrackId()

Bool_t TMCManagerStack::HasTrackId ( Int_t trackId ) const

private

Check whether track trackId exists.

Definition at line 237 of file TMCManagerStack.cxx.

◆ PopNextTrack()

TParticle * TMCManagerStack::PopNextTrack ( Int_t & itrack )

finaloverridevirtual

Pop next track.

Implements TVirtualMCStack.

Definition at line 56 of file TMCManagerStack.cxx.

◆ PopPrimaryForTracking() [1/2]

TParticle * TMCManagerStack::PopPrimaryForTracking ( Int_t i )

finaloverridevirtual

Pop i'th primar, that does not mean that this primariy also has ID==i.

Pop i'th primary; that does not mean that this primariy has ID==i.

Implements TVirtualMCStack.

Definition at line 80 of file TMCManagerStack.cxx.

◆ PopPrimaryForTracking() [2/2]

TParticle * TMCManagerStack::PopPrimaryForTracking	(	Int_t	i,
		Int_t &	itrack
	)

Pop i'th primary, that does not mean that this primariy also has ID==i.

Pop i'th primary; that does not mean that this primariy has ID==i.

including actual index

Definition at line 92 of file TMCManagerStack.cxx.

◆ PushPrimaryTrackId()

void TMCManagerStack::PushPrimaryTrackId ( Int_t trackId )

private

Push primary id to be processed.

Push primary track id to be processed.

Definition at line 277 of file TMCManagerStack.cxx.

◆ PushSecondaryTrackId()

void TMCManagerStack::PushSecondaryTrackId ( Int_t trackId )

private

Push secondary id to be processed.

Push secondary track id to be processed.

Definition at line 287 of file TMCManagerStack.cxx.

◆ PushTrack()

void TMCManagerStack::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
	)

finaloverridevirtual

This will just forward the call to the fUserStack's PushTrack.

Create a new particle and push into stack;

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, py, pz - particle momentum [GeV/c]
e - total energy [GeV]
vx, vy, vz - position [cm]
tof - time of flight [s]
polx, poly, polz - polarization
mech - creator process VMC code
ntr - track number (is filled by the stack
weight - particle weight
is - generation status code

Implements TVirtualMCStack.

Definition at line 42 of file TMCManagerStack.cxx.

◆ ResetInternals()

void TMCManagerStack::ResetInternals ( )

private

Reset internals, clear engine stack and fParticles and reset buffered values.

Definition at line 297 of file TMCManagerStack.cxx.

◆ SetCurrentTrack()

void TMCManagerStack::SetCurrentTrack ( Int_t trackId )

finaloverridevirtual

Set the current track id from the outside and forward this to the user's stack.

Implements TVirtualMCStack.

Definition at line 187 of file TMCManagerStack.cxx.

◆ SetUserStack()

void TMCManagerStack::SetUserStack ( TVirtualMCStack * stack )

private

Set the user stack.

Definition at line 250 of file TMCManagerStack.cxx.

Friends And Related Symbol Documentation

◆ TMCManager

friend class TMCManager

friend

Definition at line 115 of file TMCManagerStack.h.

Member Data Documentation

◆ fBranchArrayContainer

TGeoMCBranchArrayContainer* TMCManagerStack::fBranchArrayContainer

private

Storage of TGeoBranchArray pointers.

Definition at line 146 of file TMCManagerStack.h.

◆ fCurrentTrackId

Int_t TMCManagerStack::fCurrentTrackId

private

Pointer to current track.

Definition at line 134 of file TMCManagerStack.h.

◆ fParticles

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

private

All tracks linked from the TMCManager.

Definition at line 142 of file TMCManagerStack.h.

◆ fParticlesStatus

std::vector<std::unique_ptr<TMCParticleStatus> >* TMCManagerStack::fParticlesStatus

private

All TMCParticleStatus linked from the TMCManager.

Definition at line 144 of file TMCManagerStack.h.

◆ fPrimariesStack

std::stack<Int_t> TMCManagerStack::fPrimariesStack

private

IDs of primaries to be tracked.

Definition at line 148 of file TMCManagerStack.h.

◆ fSecondariesStack

std::stack<Int_t> TMCManagerStack::fSecondariesStack

private

IDs of secondaries to be trackedk.

Definition at line 150 of file TMCManagerStack.h.

◆ fTotalNPrimaries

Int_t* TMCManagerStack::fTotalNPrimaries

private

Number of all primaries ever pushed linked from the TMCManager.

Definition at line 138 of file TMCManagerStack.h.

◆ fTotalNTracks

Int_t* TMCManagerStack::fTotalNTracks

private

Number of all tracks ever pushed linked from the TMCManager.

Definition at line 140 of file TMCManagerStack.h.

◆ fUserStack

TVirtualMCStack* TMCManagerStack::fUserStack

private

Pointer to user stack for forwarding PushTrack calls.

Definition at line 136 of file TMCManagerStack.h.

Libraries for TMCManagerStack:

[legend]

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

montecarlo/vmc/inc/TMCManagerStack.h
montecarlo/vmc/src/TMCManagerStack.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TMCManagerStack()

◆ ~TMCManagerStack()

Member Function Documentation

◆ ConnectTrackContainers()

◆ GetCurrentGeoState()

◆ GetCurrentParentTrackNumber()

◆ GetCurrentTrack()

◆ GetCurrentTrackNumber()

◆ GetGeoState()

◆ GetNprimary()

◆ GetNtrack()

◆ GetParticleStatus()

◆ GetStackedNprimary()

◆ GetStackedNtrack()

◆ HasTrackId()

◆ PopNextTrack()

◆ PopPrimaryForTracking() [1/2]

◆ PopPrimaryForTracking() [2/2]

◆ PushPrimaryTrackId()

◆ PushSecondaryTrackId()

◆ PushTrack()

◆ ResetInternals()

◆ SetCurrentTrack()

◆ SetUserStack()

Friends And Related Symbol Documentation

◆ TMCManager

Member Data Documentation

◆ fBranchArrayContainer

◆ fCurrentTrackId

◆ fParticles

◆ fParticlesStatus

◆ fPrimariesStack

◆ fSecondariesStack

◆ fTotalNPrimaries

◆ fTotalNTracks

◆ fUserStack