G4NavigationHistoryPool Class Reference

G4NavigationHistoryPool is a thread-local pool for navigation history levels collections being allocated by G4NavigationHistory. It allows for reuse of the vectors allocated according to lifetime of G4NavigationHistory objects. More...

#include <G4NavigationHistoryPool.hh>

Public Member Functions
	~G4NavigationHistoryPool ()
std::vector< G4NavigationLevel > *	GetNewLevels ()
std::vector< G4NavigationLevel > *	GetLevels ()
void	DeRegister (std::vector< G4NavigationLevel > *pLevels)
void	Clean ()
void	Print () const

Static Public Member Functions
static G4NavigationHistoryPool *	GetInstance ()

Detailed Description

G4NavigationHistoryPool is a thread-local pool for navigation history levels collections being allocated by G4NavigationHistory. It allows for reuse of the vectors allocated according to lifetime of G4NavigationHistory objects.

Definition at line 50 of file G4NavigationHistoryPool.hh.

Constructor & Destructor Documentation

~G4NavigationHistoryPool()

G4NavigationHistoryPool::~G4NavigationHistoryPool

(

)

Destructor: takes care to delete the allocated levels.

Definition at line 57 of file G4NavigationHistoryPool.cc.

{
  Clean(); fgInstance = nullptr;
}

Member Function Documentation

Clean()

void G4NavigationHistoryPool::Clean

(

)

Deletes all levels stored in the pool.

Definition at line 66 of file G4NavigationHistoryPool.cc.

{
  for(auto & i : fPool)
  {
    delete i;
  }
  fPool.clear();
  fFree.clear();
}

Referenced by ~G4NavigationHistoryPool().

DeRegister()

void G4NavigationHistoryPool::DeRegister ( std::vector< G4NavigationLevel > * pLevels )

inline

Deactivates the levels collection in pool.

Definition at line 129 of file G4NavigationHistoryPool.hh.

{
  fFree.push_back(pLevels);
}

Referenced by G4NavigationHistory::~G4NavigationHistory().

GetInstance()

G4NavigationHistoryPool * G4NavigationHistoryPool::GetInstance ( )

static

Returns the unique instance of G4NavigationHistoryPool.

Definition at line 108 of file G4NavigationHistoryPool.cc.

{
  if (fgInstance == nullptr)
  {
    fgInstance = new G4NavigationHistoryPool;
  }
  return fgInstance;
}

Referenced by G4NavigationHistory::G4NavigationHistory(), G4NavigationHistory::G4NavigationHistory(), G4NavigationHistory::~G4NavigationHistory(), and G4RunManagerKernel::~G4RunManagerKernel().

GetLevels()

std::vector< G4NavigationLevel > * G4NavigationHistoryPool::GetLevels ( )

inline

Returns the pointer of the first available collection of levels If none are available (i.e. empty free vector) allocates the collection.

Definition at line 152 of file G4NavigationHistoryPool.hh.

{
  std::vector<G4NavigationLevel> * levels = nullptr;
 
  if (!fFree.empty())
  {
    levels = fFree.back();
    fFree.pop_back();
  }
  else
  {
    levels = GetNewLevels();
  }
 
  return levels;
}

Referenced by G4NavigationHistory::G4NavigationHistory(), and G4NavigationHistory::G4NavigationHistory().

GetNewLevels()

std::vector< G4NavigationLevel > * G4NavigationHistoryPool::GetNewLevels ( )

inline

Returns the pointer to a new collection of levels being allocated.

Definition at line 139 of file G4NavigationHistoryPool.hh.

{
  auto aLevelVec = new std::vector<G4NavigationLevel>(kHistoryMax);
  Register(aLevelVec);
 
  return aLevelVec;
}

Referenced by GetLevels().

Print()

void G4NavigationHistoryPool::Print

(

)

const

Prints the number of entries.

Definition at line 80 of file G4NavigationHistoryPool.cc.

{
#ifdef G4VERBOSE
  G4cout << "Total navigation history collections cleaned: "
         << fPool.size() << G4endl;
#endif
}

Referenced by G4RunManagerKernel::~G4RunManagerKernel().

---

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

• G4NavigationHistoryPool.hh
• G4NavigationHistoryPool.cc