Import Geant4 11.0.0 source tree

This commit is contained in:
Gabriele Cosmo
2021-12-10 14:46:44 +01:00
committed by Ben Morgan
parent 6399a014b6
commit 80e2389dd8
3932 changed files with 202519 additions and 246221 deletions
@@ -24,18 +24,13 @@
// ********************************************************************
//
// Author: Ivana Hrivnacova, 10/09/2019 (ivana@ipno.in2p3.fr)
// Author: Ivana Hrivnacova, 21/09/2021 (ivana@ipno.in2p3.fr)
#ifndef g4analysis_defs_h
#define g4analysis_defs_h 1
#ifndef G4AnalysisManager_h
#define G4AnalysisManager_h
#include "g4hntools_defs.hh"
#include "G4ToolsAnalysisManager.hh"
#include "G4GenericAnalysisManager.hh"
using G4AnalysisManager = G4ToolsAnalysisManager;
using G4AnalysisManager = G4GenericAnalysisManager;
#endif
@@ -25,7 +25,7 @@
//
// The main manager for Root analysis.
// It delegates most of functions to the object specific managers.
// It delegates most of functions to the object specific managers.
// Author: Ivana Hrivnacova, 18/06/2013 (ivana@ipno.in2p3.fr)
@@ -34,24 +34,28 @@
#include "G4ToolsAnalysisManager.hh"
#include "G4THnManager.hh"
#include "G4Threading.hh"
#include "G4AnalysisUtilities.hh"
#include "globals.hh"
#include <memory>
#include <string_view>
class G4GenericAnalysisManager;
class G4GenericFileManager;
class G4HnInformation;
class G4VNtupleFileManager;
template <class T>
class G4ThreadLocalSingleton;
class G4GenericAnalysisManager : public G4ToolsAnalysisManager
{
friend class G4RootMpiAnalysisManager;
friend class G4ThreadLocalSingleton<G4GenericAnalysisManager>;
public:
explicit G4GenericAnalysisManager(G4bool isMaster = true);
virtual ~G4GenericAnalysisManager();
// static methods
// Static methods
static G4GenericAnalysisManager* Instance();
static G4bool IsInstance();
@@ -62,51 +66,53 @@ class G4GenericAnalysisManager : public G4ToolsAnalysisManager
virtual void SetBasketSize(unsigned int basketSize) override;
virtual void SetBasketEntries(unsigned int basketEntries) override;
// new functions
G4bool Merge();
// write in an extra file
// write in an extra file
G4bool WriteH1(G4int id, const G4String& fileName);
G4bool WriteH2(G4int id, const G4String& fileName);
G4bool WriteH3(G4int id, const G4String& fileName);
G4bool WriteP1(G4int id, const G4String& fileName);
G4bool WriteP2(G4int id, const G4String& fileName);
// set default output type (backward compatibility)
// Set default output type (backward compatibility)
// this type will be used for file names without extension
void SetDefaultFileType(const G4String& value);
G4String GetDefaultFileType() const;
protected:
// virtual methods from base class
// Virtual methods from base class
virtual G4bool OpenFileImpl(const G4String& fileName) override;
virtual G4bool WriteImpl() final;
virtual G4bool CloseFileImpl(G4bool reset = true) override;
virtual G4bool CloseFileImpl(G4bool reset = true) override;
virtual G4bool ResetImpl() final;
virtual G4bool IsOpenFileImpl() const final;
virtual G4bool Reset() final;
// File manager access
virtual std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName) final;
private:
// methods
G4GenericAnalysisManager();
// Methods
void CreateNtupleFileManager(const G4String& fileName);
// static data members
static G4GenericAnalysisManager* fgMasterInstance;
static G4ThreadLocal G4GenericAnalysisManager* fgInstance;
// Static data members
inline static G4GenericAnalysisManager* fgMasterInstance { nullptr };
inline static G4ThreadLocal G4bool fgIsInstance { false };
static constexpr std::string_view fkClass { "G4GenericAnalysisManager" };
// data members
std::shared_ptr<G4GenericFileManager> fFileManager;
// Data members
std::shared_ptr<G4GenericFileManager> fFileManager { nullptr };
// add G4GenericNtupleManager
// this class will be analogic to file managers but with ntuples
std::shared_ptr<G4VNtupleFileManager> fNtupleFileManager;
std::shared_ptr<G4VNtupleFileManager> fNtupleFileManager { nullptr };
// data members
G4bool fIsNtupleMergingSet = false;
G4int fNofNtupleFiles = 0;
G4bool fMergeNtuples = false;
G4bool fNtupleRowWise = false;
G4bool fNtupleRowMode = true;
unsigned int fBasketSize = fgkDefaultBasketSize;
unsigned int fBasketEntries = fgkDefaultBasketEntries;
// Data members
G4bool fIsNtupleMergingSet { false };
G4int fNofNtupleFiles { 0 };
G4bool fMergeNtuples { false };
G4bool fNtupleRowWise { false };
G4bool fNtupleRowMode { true };
unsigned int fBasketSize { G4Analysis::kDefaultBasketSize };
unsigned int fBasketEntries { G4Analysis::kDefaultBasketEntries };
};
#include "G4GenericAnalysisManager.icc"
@@ -27,6 +27,13 @@
#include "G4GenericFileManager.hh"
#include "G4AutoLock.hh"
//_____________________________________________________________________________
inline std::shared_ptr<G4VFileManager> G4GenericAnalysisManager::GetFileManager(
const G4String& fileName)
{
return fFileManager->GetFileManager(fileName);
}
//_____________________________________________________________________________
inline void G4GenericAnalysisManager::SetNtupleMerging(
G4bool mergeNtuples, G4int nofReducedNtupleFiles)
@@ -37,6 +37,7 @@
#include <vector>
#include <memory>
#include <string_view>
class G4HnInformation;
class G4VNtupleFileManager;
@@ -52,7 +53,7 @@ class G4GenericFileManager : public G4VFileManager
{
public:
explicit G4GenericFileManager(const G4AnalysisManagerState& state);
virtual ~G4GenericFileManager();
virtual ~G4GenericFileManager() = default;
// Method to manipulate a default file
virtual G4bool OpenFile(const G4String& fileName) final;
@@ -63,50 +64,58 @@ class G4GenericFileManager : public G4VFileManager
virtual G4bool CloseFiles() final;
virtual G4bool DeleteEmptyFiles() final;
// Clear all data
virtual void Clear() final;
// Methods applied to file per name
virtual G4bool CreateFile(const G4String& fileName) final;
virtual G4bool WriteFile(const G4String& fileName) final;
virtual G4bool CloseFile(const G4String& fileName) final;
virtual G4bool SetIsEmpty(const G4String& fileName, G4bool isEmpty) final;
virtual G4bool SetHistoDirectoryName(const G4String& dirName);
virtual G4bool SetNtupleDirectoryName(const G4String& dirName);
virtual G4String GetFileType() const final { return ""; }
// set default output type (backward compatibility)
// Set default output type (backward compatibility)
// this type will be used for file names without extension
void SetDefaultFileType(const G4String& value);
G4String GetDefaultFileType() const;
template <typename T>
G4bool WriteT(const std::vector<T*>& htVector,
const std::vector<G4HnInformation*>& hnVector);
// Get file manager for a specific output type
std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName);
template <typename T>
G4bool WriteTExtra(const G4String& fileName, T* ht, const G4String& htName);
template <typename HT>
G4bool WriteTExtra(const G4String& fileName, HT* ht, const G4String& htName);
// methods
// Methods
std::shared_ptr<G4VNtupleFileManager> CreateNtupleFileManager(G4AnalysisOutput output);
private:
// methods
// Methods
void CreateFileManager(G4AnalysisOutput output);
std::shared_ptr<G4VFileManager> GetFileManager(G4AnalysisOutput output) const;
std::shared_ptr<G4VFileManager> GetFileManager(const G4String& fileName);
std::shared_ptr<G4VFileManager> GetFileManager(G4AnalysisOutput output) const;
// constants
static const G4String fgkDefaultFileType;
// Static data members
static constexpr std::string_view fkClass { "G4GenericFileManager" };
// inline static const G4String fgkDefaultFileType { "root" };
// inline static const G4String fgkDefaultFileType { "undefined" };
// data members
// Data members
G4String fDefaultFileType;
std::shared_ptr<G4VFileManager> fDefaultFileManager;
std::vector<std::shared_ptr<G4VFileManager>> fFileManagers;
std::shared_ptr<G4CsvFileManager> fCsvFileManager;
std::shared_ptr<G4VFileManager> fDefaultFileManager { nullptr };
std::vector<std::shared_ptr<G4VFileManager>> fFileManagers {
// Csv, Hdf5, Root, Xml
nullptr, nullptr, nullptr, nullptr
};
std::shared_ptr<G4CsvFileManager> fCsvFileManager { nullptr };
#ifdef TOOLS_USE_HDF5
std::shared_ptr<G4Hdf5FileManager> fHdf5FileManager;
std::shared_ptr<G4Hdf5FileManager> fHdf5FileManager { nullptr };
#endif
std::shared_ptr<G4RootFileManager> fRootFileManager;
std::shared_ptr<G4XmlFileManager> fXmlFileManager;
G4bool fHdf5Warn;
std::shared_ptr<G4RootFileManager> fRootFileManager { nullptr };
std::shared_ptr<G4XmlFileManager> fXmlFileManager { nullptr };
G4bool fHdf5Warn { true };
};
#include "G4GenericFileManager.icc"
@@ -33,122 +33,26 @@ inline G4String G4GenericFileManager::GetDefaultFileType() const
}
//_____________________________________________________________________________
template <typename T>
inline
G4bool G4GenericFileManager::WriteT(const std::vector<T*>& htVector,
const std::vector<G4HnInformation*>& hnVector)
{
auto finalResult = true;
for ( G4int i=0; i<G4int(htVector.size()); ++i ) {
auto info = hnVector[i];
auto activation = info->GetActivation();
// skip writing if activation is enabled and H1 is inactivated
if ( fState.GetIsActivation() && ( ! activation ) ) continue;
auto name = info->GetName();
auto ht = htVector[i];
auto fileName = info->GetFileName();
auto fileManager = fDefaultFileManager;
auto fileKind = "default";
if ( fileName == "" ) {
fileName = fileManager->GetFileName();
} else {
fileManager = GetFileManager(fileName);
fileKind = "extra";
// skip writing if cannot get file manager (wrong file extension)
if ( ! fileManager ) {
if ( G4Analysis::GetExtension(fileName) != "hdf5" || fHdf5Warn ) {
G4ExceptionDescription description;
description
<< "Cannot get file manager for " << fileKind << " file " << fileName << "." << G4endl
<< "Writing " << G4Analysis::GetHnType<T>() << " " << name
<< " will be skipped.";
G4Exception("G4GenericFileManager::WriteT",
"Analysis_W022", JustWarning, description);
}
#ifdef G4VERBOSE
if ( fState.GetVerboseL3() ) {
G4ExceptionDescription description;
description << " " << name << " in the " << fileKind << " file " << fileName;
fState.GetVerboseL3()
->Message("write", G4Analysis::GetHnType<T>(), description, false);
}
#endif
continue;
}
}
#ifdef G4VERBOSE
if ( fState.GetVerboseL4() ) {
G4ExceptionDescription description;
description << " " << name << " in the " << fileKind << " file " << fileName;
fState.GetVerboseL3()
->Message("write", G4Analysis::GetHnType<T>(), description);
}
#endif
auto result = fileManager->GetHnFileManager<T>()->Write(ht, name, fileName);
if ( ! result ) {
G4ExceptionDescription description;
description
<< "Writing " << G4Analysis::GetHnType<T>() << " " << name
<< " to file " << fileName << " failed.";
G4Exception("G4GenericManager::WriteT()",
"Analysis_W022", JustWarning, description);
}
finalResult = result && finalResult;
// notify that file has a written object
fileManager->SetIsEmpty(fileName, false);
#ifdef G4VERBOSE
if ( fState.GetVerboseL3() ) {
G4ExceptionDescription description;
description << " " << name << " in the " << fileKind << " file " << fileName;
fState.GetVerboseL3()
->Message("write", G4Analysis::GetHnType<T>(), description, finalResult);
}
#endif
}
return finalResult;
}
//_____________________________________________________________________________
template <typename T>
inline
template <typename HT>
inline
G4bool G4GenericFileManager::WriteTExtra(
const G4String& fileName, T* ht, const G4String& htName)
const G4String& fileName, HT* ht, const G4String& htName)
{
if ( fState.GetVerboseL4() ) {
G4ExceptionDescription description;
description
<< fileName << " with " << G4Analysis::GetHnType<T>() << " " << htName;
fState.GetVerboseL4()->Message("write", "extra file", description);
}
Message(G4Analysis::kVL4, "write", "extra file",
fileName + " with " + G4Analysis::GetHnType<HT>() + " " + htName);
std::shared_ptr<G4VFileManager> fileManager = GetFileManager(fileName);
if ( ! fileManager ) {
G4ExceptionDescription description;
description
<< "Cannot get file manager for file " << fileName << "." << G4endl
<< "Writing " << G4Analysis::GetHnType<T>() << " " << htName
<< " failed.";
G4Exception("G4GenericFileManager::WriteTExtra",
"Analysis_W022", JustWarning, description);
G4Analysis::Warn(
"Cannot get file manager for " + fileName + " .\n" +
"Writing " + G4Analysis::GetHnType<HT>() + " " + htName + " failed.",
fkClass, "WriteTExtra");
return false;
}
auto result = fileManager->GetHnFileManager<T>()->WriteExtra(ht, htName, fileName);
auto result = fileManager->GetHnFileManager<HT>()->WriteExtra(ht, htName, fileName);
#ifdef G4VERBOSE
if ( fState.GetVerboseL1() ) {
fState.GetVerboseL1()->Message("write", "extra file", fileName, result);
}
#endif
Message(G4Analysis::kVL1, "write", "extra file", fileName, result);
return result;
return result;
}
@@ -1,46 +0,0 @@
//
// ********************************************************************
// * 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. *
// ********************************************************************
//
// Author: Ivana Hrivnacova, 10/09/2019 (ivana@ipno.in2p3.fr)
#ifndef g4analysis_h
#define g4analysis_h 1
#include "globals.hh"
#include "g4analysis_defs.hh"
namespace G4Analysis
{
G4ToolsAnalysisManager* ManagerInstance(const G4String& outputType);
}
#endif