TSRun Class Reference

#include <TSRun.hh>

Inheritance diagram for TSRun:

Collaboration diagram for TSRun:

Public Types
typedef std::map< G4int, G4double >	MutexHitsMap_t
typedef std::vector< G4atomic< G4double > * >	AtomicHitsSum_t

Public Member Functions
	TSRun (const G4String &)
virtual	~TSRun ()
virtual void	RecordEvent (const G4Event *)
G4THitsMap< G4double > *	GetHitsMap (const G4String &collname) const
G4TAtomicHitsMap< G4double > *	GetAtomicHitsMap (const G4String &) const
MutexHitsMap_t *	GetMutexHitsMap (const G4String &) const
void	ConstructMFD (const G4String &)
virtual void	Merge (const G4Run *)
Public Member Functions inherited from G4Run
	G4Run ()
virtual	~G4Run ()
G4int	GetRunID () const
G4int	GetNumberOfEvent () const
G4int	GetNumberOfEventToBeProcessed () const
const G4HCtable *	GetHCtable () const
const G4DCtable *	GetDCtable () const
const G4String &	GetRandomNumberStatus () const
void	SetRunID (G4int id)
void	SetNumberOfEventToBeProcessed (G4int n_ev)
void	SetHCtable (G4HCtable *HCtbl)
void	SetDCtable (G4DCtable *DCtbl)
void	SetRandomNumberStatus (G4String &st)
void	StoreEvent (G4Event *evt)
const std::vector< const G4Event * > *	GetEventVector () const

Private Attributes
std::vector< G4String >	fCollNames
std::vector< G4int >	fCollIDs
std::vector< G4THitsMap< G4double > * >	fRunMaps

Static Private Attributes
static AtomicHitsSum_t	fAtomicRunSums
static std::vector< G4TAtomicHitsMap< G4double > * >	fAtomicRunMaps
static std::map< G4String, MutexHitsMap_t >	fMutexRunMaps

Additional Inherited Members
Protected Attributes inherited from G4Run
G4int	runID
G4int	numberOfEvent
G4int	numberOfEventToBeProcessed
G4HCtable *	HCtable
G4DCtable *	DCtable
G4String	randomNumberStatus
std::vector< const G4Event * > *	eventVector

Detailed Description

Definition at line 70 of file TSRun.hh.

Member Typedef Documentation

AtomicHitsSum_t

typedef std::vector<G4atomic<G4double>*> TSRun::AtomicHitsSum_t

Definition at line 74 of file TSRun.hh.

MutexHitsMap_t

typedef std::map<G4int, G4double> TSRun::MutexHitsMap_t

Definition at line 73 of file TSRun.hh.

Constructor & Destructor Documentation

TSRun()

TSRun::TSRun

(

const G4String &

mfd_name

)

Definition at line 70 of file TSRun.cc.

: G4Run()
{
    ConstructMFD(mfd_name);
}

Here is the call graph for this function:

~TSRun()

TSRun::~TSRun ( )

virtual

Definition at line 78 of file TSRun.cc.

{
    //--- Clear HitsMap for RUN
    for(unsigned i = 0; i < fRunMaps.size(); ++i)
        fRunMaps[i]->clear();

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

}

Here is the call graph for this function:

Member Function Documentation

ConstructMFD()

void TSRun::ConstructMFD

(

const G4String &

mfdName

)

Definition at line 93 of file TSRun.cc.

{

    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));
                if(!G4Threading::IsWorkerThread())
                {
                  fAtomicRunMaps.push_back(new G4TAtomicHitsMap<G4double>
                                           (mfdName, collectionName));
                }
            } else {
                G4cout << "** collection " << fullCollectionName << " not found. "
                <<G4endl;
            }
        }
    }

}

Here is the call graph for this function:

Here is the caller graph for this function:

GetAtomicHitsMap()

G4TAtomicHitsMap< G4double > * TSRun::GetAtomicHitsMap

(

const G4String &

collName

)

const

Definition at line 231 of file TSRun.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetHitsMap()

G4THitsMap< G4double > * TSRun::GetHitsMap

(

const G4String &

collname

)

const

Definition at line 212 of file TSRun.cc.

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

Here is the call graph for this function:

Here is the caller graph for this function:

GetMutexHitsMap()

TSRun::MutexHitsMap_t * TSRun::GetMutexHitsMap

(

const G4String &

collName

)

const

Definition at line 250 of file TSRun.cc.

{
  if(fMutexRunMaps.find(collName) != fMutexRunMaps.end())
    return &fMutexRunMaps[collName];

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

Here is the call graph for this function:

Here is the caller graph for this function:

Merge()

void TSRun::Merge ( const G4Run *  aTSRun )

virtual

Reimplemented from G4Run.

Definition at line 197 of file TSRun.cc.

{
    const TSRun* localTSRun = static_cast<const TSRun*>(aTSRun);

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

    G4Run::Merge(aTSRun);
}

Here is the call graph for this function:

RecordEvent()

void TSRun::RecordEvent ( const G4Event *  aEvent )

virtual

Reimplemented from G4Run.

Definition at line 147 of file TSRun.cc.

{
  numberOfEvent++;  // This is an original line.

  //=============================
  // 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;

    if ( EvtMap )
    {
      //=== Sum up HitsMap of this event to HitsMap of RUN.===
      *fRunMaps[fCollID] += *EvtMap;
      // atomic run map
      *fAtomicRunMaps[fCollID] += *EvtMap;
      // mutex run map
      static G4Mutex mtx = G4MUTEX_INITIALIZER;
      {
        G4AutoLock lock(&mtx);
        auto itr = EvtMap->GetMap()->begin();
        for(; itr != EvtMap->GetMap()->end(); itr++)
        {
          fMutexRunMaps[fCollNames[fCollID]][itr->first] += *itr->second;
        }
      }
      //----------------------------------------------------------------//
    }

  }

  G4Run::RecordEvent(aEvent);

}

Here is the call graph for this function:

Member Data Documentation

fAtomicRunMaps

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

staticprivate

TSRun contains three collections of hits maps: a thread-local hits map, a global atomic hits map (implemented as a static since TSRun is implemented as a thread-local instance), and a global "mutex" hits map (also implemented as a static). The thread-local hits map is the same as you will find in many other examples. The atomics hits map is the purpose of this example. Code-wise, the implementation looks extremely similar to the thread-local version with the 3 primary exceptions: (1) construction - there should only be one instance so it should be a static member variable or a pointer/reference to a single instance elsewhere in the code (stored in ActionInitialization, for instance); (2) It does not need to, nor should be, summed in G4Run::Merge(); and (3) destruction – it should only be cleared by the master thread since there is only one instance. A "mutex" hits map is also included as reference for checking the results accumulated by the thread-local hits maps and atomic hits maps. The differences w.r.t. this hits maps are computed in TSRunAction::EndOfRunAction

Definition at line 99 of file TSRun.hh.

fAtomicRunSums

AtomicHitsSum_t TSRun::fAtomicRunSums

staticprivate

Definition at line 98 of file TSRun.hh.

fCollIDs

std::vector<G4int> TSRun::fCollIDs

private

Definition at line 96 of file TSRun.hh.

fCollNames

std::vector<G4String> TSRun::fCollNames

private

Definition at line 95 of file TSRun.hh.

fMutexRunMaps

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

staticprivate

Definition at line 100 of file TSRun.hh.

fRunMaps

std::vector<G4THitsMap<G4double>*> TSRun::fRunMaps

private

Definition at line 97 of file TSRun.hh.

---

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

• TSRun.hh
• TSRun.cc