TSRun.cc

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file TSRun.cc

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
//
//
//
//
//
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......


#include "TSRun.hh"

#include "G4SDManager.hh"
#include "G4MultiFunctionalDetector.hh"
#include "G4VPrimitiveScorer.hh"
#include "G4TiMemory.hh"
#include "TSDetectorConstruction.hh"

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

std::vector<G4TAtomicHitsMap<G4double>*> TSRun::fAtomicRunMaps;

std::map<G4String, TSRun::MutexHitsMap_t> TSRun::fMutexRunMaps;

std::vector<G4StatContainer<G4ConvergenceTester>*> TSRun::fConvMaps;

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

TSRun::TSRun(const G4String& mfd_name)
: G4Run()
{
    ConstructMFD(mfd_name);
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

TSRun::~TSRun()
{
    //--- Clear HitsMap for RUN
    for(unsigned i = 0; i < fRunMaps.size(); ++i)
        delete fRunMaps[i];

    if(!G4Threading::IsWorkerThread())
    {
        for(unsigned i = 0; i < fAtomicRunMaps.size(); ++i)
            delete fAtomicRunMaps[i];

        for(auto& itr: fConvMaps)
            delete itr;

        fAtomicRunMaps.clear();
        fMutexRunMaps.clear();
        fConvMaps.clear();
    }
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

//    clear all data members.
void TSRun::ConstructMFD(const G4String& mfdName)
{

    G4SDManager* SDman = G4SDManager::GetSDMpointer();
    //=================================================
    //  Initalize RunMaps for accumulation.
    //  Get CollectionIDs for HitCollections.
    //=================================================
    G4MultiFunctionalDetector* mfd =
        (G4MultiFunctionalDetector*)(SDman->FindSensitiveDetector(mfdName));
    //
    if ( mfd )
    {
      //--- Loop over the registered primitive scorers.
      for (G4int icol = 0; icol < mfd->GetNumberOfPrimitives(); icol++){
        // Get Primitive Scorer object.
        G4VPrimitiveScorer* scorer = mfd->GetPrimitive(icol);
        // collection name and collectionID for HitsCollection,
        // where type of HitsCollection is G4THitsMap in case
        // of primitive scorer.
        // The collection name is given by <MFD name>/<Primitive
        // Scorer name>.
        G4String collectionName = scorer->GetName();
        G4String fullCollectionName = mfdName+"/"+collectionName;
        G4int    collectionID = SDman->GetCollectionID(fullCollectionName);
        //
        if ( collectionID >= 0 ){
          G4cout << "++ " << fullCollectionName<< " id " << collectionID
                 << G4endl;
          // Store obtained HitsCollection information into data members.
          // And, creates new G4THitsMap for accumulating quantities during RUN.
          fCollNames.push_back(fullCollectionName);
          fCollIDs.push_back(collectionID);
          fRunMaps.push_back(new G4THitsMap<G4double>(mfdName,
                                                      collectionName));
          fStatMaps.push_back(new G4StatContainer<G4StatAnalysis>(
                            mfdName,
                            collectionName,
                            TSDetectorConstruction::Instance()->GetTotalTargets()));
          if(!G4Threading::IsWorkerThread())
          {
            fAtomicRunMaps.push_back(new G4TAtomicHitsMap<G4double>
                                     (mfdName, collectionName));
            fMutexRunMaps[fCollNames[collectionID]].clear();
            fConvMaps.push_back(new G4StatContainer<G4ConvergenceTester>(
                            mfdName,
                            collectionName,
                            TSDetectorConstruction::Instance()->GetTotalTargets()));
          }
        } else {
          G4cout << "** collection " << fullCollectionName << " not found. "
                 <<G4endl;
        }
      }
    }

}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
//
//  RecordEvent is called at end of event.
//  For scoring purpose, the resultant quantity in a event,
//  is accumulated during a TSRun.
void TSRun::RecordEvent(const G4Event* aEvent)
{
    G4Run::RecordEvent(aEvent);

    //=============================
    // HitsCollection of This Event
    //============================
    G4HCofThisEvent* HCE = aEvent->GetHCofThisEvent();
    if (!HCE)
        return;

    for(unsigned i = 0; i < fCollIDs.size(); ++i)
    {
        G4int fCollID = fCollIDs.at(i);
        //=======================================================
        // Sum up HitsMap of this Event into HitsMap of this RUN
        //=======================================================
        G4THitsMap<G4double>* EvtMap = 0;
        if ( fCollID >= 0 )           // Collection is attached to HCE
            EvtMap = static_cast<G4THitsMap<G4double>*>(HCE->GetHC(fCollID));
        else
            G4cout <<" Error EvtMap Not Found " << G4endl;

        TIMEMORY_AUTO_TIMER("[" + fCollNames.at(i) + "]");

        if ( EvtMap )
        {
            //=== Sum up HitsMap of this event to HitsMap of RUN.===
            {
                TIMEMORY_BASIC_AUTO_TIMER("[standard_run_map]");
                *fRunMaps[fCollID] += *EvtMap;
            }
            //=== Sum up HitsMap of this event to atomic HitsMap of RUN.===
            {
                TIMEMORY_BASIC_AUTO_TIMER("[atomic_run_map]");
                *fAtomicRunMaps[fCollID] += *EvtMap;
            }
            //=== Sum up HitsMap of this event to StatMap of RUN.===
            {
                TIMEMORY_BASIC_AUTO_TIMER("[stat_analysis_map]");
                // G4StatAnalysis map
                *fStatMaps[fCollID] += *EvtMap;
            }
            //=== Sum up HitsMap of this event to MutexMap of RUN.===
            {
                TIMEMORY_BASIC_AUTO_TIMER("[convergence_test_map]");
                // G4ConvergenceTester run map
                static G4Mutex mtx = G4MUTEX_INITIALIZER;
                G4AutoLock lock(&mtx);
                *fConvMaps[fCollID] += *EvtMap;
            }
            //=== Sum up HitsMap of this event to MutexMap of RUN.===
            {
                TIMEMORY_BASIC_AUTO_TIMER("[mutex_run_map]");
                // mutex run map
                static G4Mutex mtx = G4MUTEX_INITIALIZER;
                G4AutoLock lock(&mtx);
                for(const auto& itr : *EvtMap)
                    fMutexRunMaps[fCollNames[fCollID]][itr.first]
                            += *itr.second;
            }
        }
    }
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

// Merge hits map from threads
void TSRun::Merge(const G4Run* aTSRun)
{
    const TSRun* localTSRun = static_cast<const TSRun*>(aTSRun);

    for(unsigned i = 0; i < fRunMaps.size(); ++i)
    {
        *fRunMaps[i] += *localTSRun->fRunMaps[i];
        *fStatMaps[i] += *localTSRun->fStatMaps[i];
    }

    G4Run::Merge(aTSRun);
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

// Access HitsMap.
// by full description of collection name, that is
// <MultiFunctional Detector Name>/<Primitive Scorer Name>
G4THitsMap<G4double>* TSRun::GetHitsMap(const G4String& collName) const
{
  for(unsigned i = 0; i < fCollNames.size(); ++i)
  {
    if(collName == fCollNames[i])
        return fRunMaps[i];
  }

  G4Exception("TSRun", collName.c_str(), JustWarning,
              "GetHitsMap failed to locate the requested HitsMap");
  return nullptr;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

// Access AtomicsHitsMap.
// by full description of collection name, that is
// <MultiFunctional Detector Name>/<Primitive Scorer Name>
G4TAtomicHitsMap<G4double>*
TSRun::GetAtomicHitsMap(const G4String& collName) const
{
  for(unsigned i = 0; i < fCollNames.size(); ++i)
  {
    if(collName == fCollNames[i])
        return fAtomicRunMaps[i];
  }

  G4Exception("TSRun", collName.c_str(), JustWarning,
              "GetHitsMap failed to locate the requested AtomicHitsMap");
  return nullptr;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

// Access AtomicsHitsMap.
// by full description of collection name, that is
// <MultiFunctional Detector Name>/<Primitive Scorer Name>
TSRun::MutexHitsMap_t*
TSRun::GetMutexHitsMap(const G4String& collName) const
{
  if(fMutexRunMaps.find(collName) != fMutexRunMaps.end())
      return &fMutexRunMaps[collName];

  G4Exception("TSRun", collName.c_str(), JustWarning,
              "GetHitsMap failed to locate the requested MutexHitsMap");
  return nullptr;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

// Access StatMap.
// by full description of collection name, that is
// <MultiFunctional Detector Name>/<Primitive Scorer Name>
G4StatContainer<G4StatAnalysis>*
TSRun::GetStatMap(const G4String& collName) const
{
    for(unsigned i = 0; i < fCollNames.size(); ++i)
    {
        if(collName == fCollNames[i])
            return fStatMaps[i];
    }

    G4Exception("TSRun", collName.c_str(), JustWarning,
                "GetStatMap failed to locate the requested StatMap");
    return nullptr;
}

//....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......

G4StatContainer<G4ConvergenceTester>*
TSRun::GetConvMap(const G4String& collName) const
{
  for(unsigned i = 0; i < fCollNames.size(); ++i)
  {
    if(collName == fCollNames[i])
        return fConvMaps[i];
  }

  G4Exception("TSRun", collName.c_str(), JustWarning,
              "GetHitsMap failed to locate the requested AtomicHitsMap");
  return nullptr;
}