FairGenericStack.h

Go to the documentation of this file.

/********************************************************************************
 *    Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
 *                                                                              *
 *              This software is distributed under the terms of the             *
 *              GNU Lesser General Public Licence (LGPL) version 3,             *
 *                  copied verbatim in the file "LICENSE"                       *
 ********************************************************************************/
// -------------------------------------------------------------------------
// -----                       FairGenericStack header file            -----
// -----           Created 10/08/04  by D. Bertini                     -----
// -------------------------------------------------------------------------

#ifndef FAIRGENERICSTACK_H
#define FAIRGENERICSTACK_H

#include <Rtypes.h>   // for Double_t, Int_t, etc
#include <TClonesArray.h>
#include <TMCProcess.h>        // for TMCProcess
#include <TVirtualMCStack.h>   // for TVirtualMCStack
#include <map>
#include <tuple>

class FairLogger;
class TParticle;
class TRefArray;
class TIterator;

class FairGenericStack : public TVirtualMCStack
{
  public:
    FairGenericStack();

    FairGenericStack(Int_t size);

    virtual ~FairGenericStack();

    virtual void PushTrack(Int_t toBeDone,
                           Int_t parentID,
                           Int_t pdgCode,
                           Double_t px,
                           Double_t py,
                           Double_t pz,
                           Double_t e,
                           Double_t vx,
                           Double_t vy,
                           Double_t vz,
                           Double_t time,
                           Double_t polx,
                           Double_t poly,
                           Double_t polz,
                           TMCProcess proc,
                           Int_t& ntr,
                           Double_t weight,
                           Int_t is,
                           Int_t secondparentID) = 0;

    virtual void FillTrackArray() {}

    virtual void UpdateTrackIndex(TRefArray* /* detArray=0 */) {}

    void SetDetArrayList(TRefArray* detArray);

    virtual void FinishPrimary() {}

    virtual void Reset() {}

    virtual void Register() {}

    virtual TClonesArray* GetListOfParticles() { return 0; }
    virtual void SetParticleArray(__attribute__((unused)) TClonesArray* partArray) {}
    virtual void SetParticleArray(__attribute__((unused)) TClonesArray* partArray,
                                  __attribute__((unused)) Int_t partFrom,
                                  __attribute__((unused)) Int_t partTo)
    {}

    virtual FairGenericStack* CloneStack() const;

    virtual void FastSimMoveParticleTo(Double_t xx,
                                       Double_t yy,
                                       Double_t zz,
                                       Double_t tt,
                                       Double_t px,
                                       Double_t py,
                                       Double_t pz,
                                       Double_t en);
    virtual void FastSimStopParticle();
    virtual void FastSimPushSecondary(Int_t parentID,
                                      Int_t pdgCode,
                                      Double_t xx,
                                      Double_t yy,
                                      Double_t zz,
                                      Double_t tt,
                                      Double_t px,
                                      Double_t py,
                                      Double_t pz,
                                      Double_t en,
                                      Double_t polx,
                                      Double_t poly,
                                      Double_t polz,
                                      TMCProcess proc,
                                      Double_t weight,
                                      Int_t is);
    virtual std::tuple<Int_t, Int_t, Int_t> FastSimGetMovedIndex()
    {
        return std::make_tuple(fFSMovedIndex, fFSFirstSecondary, fFSNofSecondaries);
    }
    virtual void FastSimClearMovedIndex()
    {
        fFSMovedIndex = -2;
        fFSFirstSecondary = -2;
        fFSNofSecondaries = 0;
    }

    template<typename T>
    void FastSimUpdateTrackIndex(T* point, Int_t& iTrack);

  protected:
    FairGenericStack(const FairGenericStack&);
    FairGenericStack& operator=(const FairGenericStack&);

    FairLogger* fLogger;   

    TRefArray* fDetList;   

    TIterator* fDetIter;

    Int_t fVerbose;

    std::map<Int_t, Int_t> fFSTrackMap;              
    std::map<Int_t, Int_t>::iterator fFSTrackIter;   
    Int_t fFSMovedIndex;                             
    Int_t fFSFirstSecondary;                         
    Int_t fFSNofSecondaries;                         

    ClassDef(FairGenericStack, 1);
};

template<typename T>
void FairGenericStack::FastSimUpdateTrackIndex(T* point, Int_t& iTrack)
{
    fFSTrackIter = fFSTrackMap.find(iTrack);   // check if point created by FastSimulation
    if (fFSTrackIter != fFSTrackMap.end()) {   // indeed the point has been created by the FastSimulation mechanism
        iTrack = fFSTrackIter->second;
        point->SetTrackID(iTrack);   // set proper TrackID
    }
}

#endif