G4AccumulableManager Class Reference

#include <G4AccumulableManager.hh>

Public Member Functions
std::vector< G4VAccumulable * >::iterator	Begin ()
std::vector< G4VAccumulable * >::const_iterator	BeginConst () const
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)
std::vector< G4VAccumulable * >::iterator	End ()
std::vector< G4VAccumulable * >::const_iterator	EndConst () const
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
void	Merge ()
template<typename T >
G4bool	RegisterAccumulable (G4Accumulable< T > &accumulable)
G4bool	RegisterAccumulable (G4VAccumulable *accumulable)
void	Reset ()
virtual	~G4AccumulableManager ()

Static Public Member Functions
static G4AccumulableManager *	Instance ()

Private Member Functions
G4bool	CheckName (const G4String &name, const G4String &where) const
	G4AccumulableManager ()
G4String	GenerateName () const
template<typename T >
G4Accumulable< T > *	GetAccumulable (G4VAccumulable *accumulable, G4bool warn) const

Private Attributes
std::vector< G4VAccumulable * >	fAccumulablesToDelete
std::map< G4String, G4VAccumulable * >	fMap
std::vector< G4VAccumulable * >	fVector
const G4String	kBaseName = "accumulable"

Static Private Attributes
static G4AccumulableManager *	fgMasterInstance { nullptr }

Friends
class	G4ThreadLocalSingleton< G4AccumulableManager >

Detailed Description

Definition at line 46 of file G4AccumulableManager.hh.

Constructor & Destructor Documentation

~G4AccumulableManager()

G4AccumulableManager::~G4AccumulableManager ( )

virtual

Definition at line 55 of file G4AccumulableManager.cc.

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

References fAccumulablesToDelete.

G4AccumulableManager()

G4AccumulableManager::G4AccumulableManager ( )

private

Definition at line 49 of file G4AccumulableManager.cc.

{
  if ( ! G4Threading::IsWorkerThread() ) fgMasterInstance = this;
}

References fgMasterInstance, and G4Threading::IsWorkerThread().

Member Function Documentation

Begin()

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

(

)

BeginConst()

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

(

)

const

CheckName()

G4bool G4AccumulableManager::CheckName ( const G4String &  name, const G4String &  where  ) const

private

Definition at line 79 of file G4AccumulableManager.cc.

{
  if ( fMap.find(name) == fMap.end() ) return true;
 
  G4ExceptionDescription description;
  description << "Name " << name << " is already used." << G4endl;
  description << "Parameter will be not created/registered.";
  G4String method("G4AccumulableManager::");
  method.append(where);
  G4Exception(method, "Analysis_W001", JustWarning, description);
  return false;
}

References fMap, G4endl, G4Exception(), JustWarning, and G4InuclParticleNames::name().

Referenced by RegisterAccumulable().

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

GenerateName()

G4String G4AccumulableManager::GenerateName ( ) const

private

Definition at line 68 of file G4AccumulableManager.cc.

{
  G4String name = kBaseName;
  std::ostringstream os;
  os << fVector.size();
  name.append("_");
  name.append(os.str());
  return name;
}

References fVector, kBaseName, and G4InuclParticleNames::name().

Referenced by RegisterAccumulable().

GetAccumulable() [1/5]

template<typename T >

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

GetAccumulable() [2/5]

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

Definition at line 117 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_W001", JustWarning, description);
    }
    return nullptr;
  }
 
  return it->second;
}

References fMap, G4Exception(), JustWarning, and G4InuclParticleNames::name().

GetAccumulable() [3/5]

template<typename T >

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

GetAccumulable() [4/5]

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

Definition at line 136 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_W001", JustWarning, description);
    }
    return nullptr;
  }
 
  return fVector[id];
}

References fVector, G4Exception(), and JustWarning.

GetAccumulable() [5/5]

template<typename T >

G4Accumulable< T > * G4AccumulableManager::GetAccumulable ( G4VAccumulable *  accumulable, G4bool  warn  ) const

private

GetNofAccumulables()

G4int G4AccumulableManager::GetNofAccumulables

(

)

const

Instance()

G4AccumulableManager * G4AccumulableManager::Instance ( )

static

Definition at line 42 of file G4AccumulableManager.cc.

{
  static G4ThreadLocalSingleton<G4AccumulableManager> instance;
  return instance.Instance();
}

References G4ThreadLocalSingleton< T >::Instance().

Merge()

void G4AccumulableManager::Merge

(

)

Definition at line 153 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_W001", 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();
}

References fgMasterInstance, fVector, G4endl, G4Exception(), G4Threading::IsWorkerThread(), JustWarning, anonymous_namespace{G4AccumulableManager.cc}::mergeMutex, and G4TemplateAutoLock< _Mutex_t >::unlock().

RegisterAccumulable() [1/2]

template<typename T >

G4bool G4AccumulableManager::RegisterAccumulable

(

G4Accumulable< T > &

accumulable

)

RegisterAccumulable() [2/2]

G4bool G4AccumulableManager::RegisterAccumulable

(

G4VAccumulable *

accumulable

)

Definition at line 97 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;
}

References CheckName(), fMap, G4VAccumulable::fName, fVector, GenerateName(), G4VAccumulable::GetName(), and G4InuclParticleNames::name().

Reset()

void G4AccumulableManager::Reset

(

)

Definition at line 187 of file G4AccumulableManager.cc.

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

References fVector.

Friends And Related Function Documentation

G4ThreadLocalSingleton< G4AccumulableManager >

friend class G4ThreadLocalSingleton< G4AccumulableManager >

friend

Definition at line 1 of file G4AccumulableManager.hh.

Field Documentation

fAccumulablesToDelete

std::vector<G4VAccumulable*> G4AccumulableManager::fAccumulablesToDelete

private

Definition at line 127 of file G4AccumulableManager.hh.

Referenced by ~G4AccumulableManager().

fgMasterInstance

G4AccumulableManager* G4AccumulableManager::fgMasterInstance { nullptr }

inlinestaticprivate

Definition at line 122 of file G4AccumulableManager.hh.

Referenced by G4AccumulableManager(), and Merge().

fMap

std::map<G4String, G4VAccumulable*> G4AccumulableManager::fMap

private

Definition at line 126 of file G4AccumulableManager.hh.

Referenced by CheckName(), GetAccumulable(), and RegisterAccumulable().

fVector

std::vector<G4VAccumulable*> G4AccumulableManager::fVector

private

Definition at line 125 of file G4AccumulableManager.hh.

Referenced by GenerateName(), GetAccumulable(), Merge(), RegisterAccumulable(), and Reset().

kBaseName

const G4String G4AccumulableManager::kBaseName = "accumulable"

private

Definition at line 119 of file G4AccumulableManager.hh.

Referenced by GenerateName().

---

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

• source/analysis/accumulables/include/G4AccumulableManager.hh
• source/analysis/accumulables/src/G4AccumulableManager.cc