G4AccumulableManager Class Reference

#include <G4AccumulableManager.hh>

Public Member Functions
virtual	~G4AccumulableManager ()
template<typename T >
G4Accumulable< T > *	CreateAccumulable (const G4String &name, T value, G4MergeMode mergeMode=G4MergeMode::kAddition)
template<typename T >
G4Accumulable< T > *	CreateAccumulable (T value, G4MergeMode mergeMode=G4MergeMode::kAddition)
template<typename T >
G4bool	RegisterAccumulable (G4Accumulable< T > &accumulable)
G4bool	RegisterAccumulable (G4VAccumulable *accumulable)
template<typename T >
G4Accumulable< T > *	GetAccumulable (const G4String &name, G4bool warn=true) const
G4VAccumulable *	GetAccumulable (const G4String &name, G4bool warn=true) const
template<typename T >
G4Accumulable< T > *	GetAccumulable (G4int id, G4bool warn=true) const
G4VAccumulable *	GetAccumulable (G4int id, G4bool warn=true) const
G4int	GetNofAccumulables () const
std::vector< G4VAccumulable * >::iterator	Begin ()
std::vector< G4VAccumulable * >::iterator	End ()
std::vector< G4VAccumulable * >::const_iterator	BeginConst () const
std::vector< G4VAccumulable * >::const_iterator	EndConst () const
void	Merge ()
void	Reset ()

Static Public Member Functions
static G4AccumulableManager *	Instance ()

Detailed Description

Definition at line 43 of file G4AccumulableManager.hh.

Constructor & Destructor Documentation

~G4AccumulableManager()

G4AccumulableManager::~G4AccumulableManager ( )

virtual

Definition at line 73 of file G4AccumulableManager.cc.

{
  // delete only accumulables create by the mager itself
  for ( auto it : fAccumulablesToDelete ) {
    delete it;
  }
}

Member Function Documentation

Begin()

std::vector< G4VAccumulable * >::iterator G4AccumulableManager::Begin

(

)

BeginConst()

std::vector< G4VAccumulable * >::const_iterator G4AccumulableManager::BeginConst

(

)

const

CreateAccumulable() [1/2]

template<typename T >

G4Accumulable< T > * G4AccumulableManager::CreateAccumulable	(	const G4String &	name,
		T	value,
		G4MergeMode	mergeMode = G4MergeMode::kAddition
	)

CreateAccumulable() [2/2]

template<typename T >

G4Accumulable< T > * G4AccumulableManager::CreateAccumulable	(	T	value,
		G4MergeMode	mergeMode = G4MergeMode::kAddition
	)

End()

std::vector< G4VAccumulable * >::iterator G4AccumulableManager::End

(

)

EndConst()

std::vector< G4VAccumulable * >::const_iterator G4AccumulableManager::EndConst

(

)

const

GetAccumulable() [1/4]

template<typename T >

G4Accumulable< T > * G4AccumulableManager::GetAccumulable	(	const G4String &	name,
		G4bool	warn = true
	)		const

GetAccumulable() [2/4]

G4VAccumulable * G4AccumulableManager::GetAccumulable	(	const G4String &	name,
		G4bool	warn = true
	)		const

Definition at line 135 of file G4AccumulableManager.cc.

{
  // get G4VParammeter from the map
  auto it = fMap.find(name);
  if ( it == fMap.end() ) {
    if ( warn) {
      G4ExceptionDescription description;
      description << "      " << "accumulable " << name << " does not exist.";
      G4Exception("G4AccumulableManager::GetAccumulable", 
                  "Analysis_W011", JustWarning, description);
    }
    return nullptr;
  }
 
  return it->second;
}

GetAccumulable() [3/4]

template<typename T >

G4Accumulable< T > * G4AccumulableManager::GetAccumulable	(	G4int	id,
		G4bool	warn = true
	)		const

GetAccumulable() [4/4]

G4VAccumulable * G4AccumulableManager::GetAccumulable	(	G4int	id,
		G4bool	warn = true
	)		const

Definition at line 154 of file G4AccumulableManager.cc.

{
  // get G4VParammeter from the vector
  if ( id < 0 || id >= G4int(fVector.size()) ) {
    if ( warn) {
      G4ExceptionDescription description;
      description << "      " << "accumulable " << id << " does not exist.";
      G4Exception("G4AccumulableManager::GetAccumulable", 
                  "Analysis_W011", JustWarning, description);
    }
    return nullptr;
  }
 
  return fVector[id];
}

GetNofAccumulables()

G4int G4AccumulableManager::GetNofAccumulables

(

)

const

Instance()

G4AccumulableManager * G4AccumulableManager::Instance ( )

static

Definition at line 44 of file G4AccumulableManager.cc.

{
  if ( fgInstance == nullptr ) {
    G4bool isMaster = ! G4Threading::IsWorkerThread();
    fgInstance = new G4AccumulableManager(isMaster);
  }
  
  return fgInstance;
}    

Merge()

void G4AccumulableManager::Merge

(

)

Definition at line 171 of file G4AccumulableManager.cc.

{
  // Do nothing if  there are no accumulables registered
  // or if master thread
  if ( (! fVector.size()) ||  (! G4Threading::IsWorkerThread()) ) return;
 
  // The manager on mastter must exist
  if ( ! fgMasterInstance ) {
    G4ExceptionDescription description;
    description 
      << "      " << "No master G4AccumulableManager instance exists." 
      << G4endl 
      << "      " << "Accumulables will not be merged.";
      G4Exception("G4AccumulableManager::Merge()",
                "Analysis_W031", JustWarning, description);
    return;
  }
 
  // The worker manager just merges its accumulables to the master
  // This operation needs a lock
  // G4cout << "Go to merge accumulables" << G4endl; 
  G4AutoLock lock(&mergeMutex);
 
  // the other manager has the vector with the "same" accumulables
  auto it = fVector.begin();
  for ( auto itMaster : fgMasterInstance->fVector ) {
    // G4VAccumulable* masterAccumulable = itMaster;
    // G4VAccumulable* accumulable = *(it++);
    // masterAccumulable->Merge(*(accumulable));
    itMaster->Merge(*(*(it++)));
  }  
  lock.unlock();
}

RegisterAccumulable() [1/2]

template<typename T >

G4bool G4AccumulableManager::RegisterAccumulable

(

G4Accumulable< T > &

accumulable

)

RegisterAccumulable() [2/2]

G4bool G4AccumulableManager::RegisterAccumulable

(

G4VAccumulable *

accumulable

)

Definition at line 115 of file G4AccumulableManager.cc.

{
  auto name = accumulable->GetName();
  
  // do not accept name if it is already used
  if ( ! CheckName(name, "RegisterAccumulable") ) return false; 
 
  // generate name if empty
  if ( ! name.length() ) {
    name =  GenerateName();
    accumulable->fName = name;
  }
 
  fMap[name] = accumulable;
  fVector.push_back(accumulable);
  return true;
}

Reset()

void G4AccumulableManager::Reset

(

)

Definition at line 206 of file G4AccumulableManager.cc.

{
// Reset histograms and profiles
  
  for ( auto it : fVector ) {
    it->Reset();
  }  
}  

---

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

• G4AccumulableManager.hh
• G4AccumulableManager.cc