GGSRootFileService.h

Go to the documentation of this file.

/*
 * GGSRootFileService.h
 *
 *  Created on: 03 Jun 2011
 *      Author: Nicola Mori
 */

#ifndef GGSROOTFILESERVICE_H_
#define GGSROOTFILESERVICE_H_

#include <filesystem>
#include <functional>
#include <list>
#include <unordered_map>
#include <vector>

#include "ROOT/TBufferMerger.hxx"
#include "TFile.h"
#include "TObjString.h"
#include "TString.h"
#include "TTree.h"

#include "G4GenericMessenger.hh"
#include "G4Run.hh"
#include "G4VPhysicalVolume.hh"

#include "montecarlo/dataobjs/GGSTSimInfo.h"
class GGSTHitDetInfo;

class GGSRootFileService {

public:
  static GGSRootFileService &GetInstance();

  TFile *GetFileForThisRun(const std::filesystem::path &baseName, const G4Run *run);

  void CloseFileForThisRun(const std::filesystem::path &baseName, const G4Run *run);

  TTree *GetDefaultTree(TFile *file);

  void SetSuffix(const std::string &suffix) { _suffix = suffix; }

  void SetDefaultFileBase(const std::filesystem::path &newFileBase) { _defaultOutBase = newFileBase; }

  int StoreVolume(TFile *tFilePtr, const std::string &detector, const G4VPhysicalVolume *volume,
                  const G4ThreeVector &position, int id);

  void SetSimInfo(const GGSTSimInfo &simInfo) { _simInfo = simInfo; }

  enum class OutputMode { SINGLEFILE, MULTIFILE };

  OutputMode GetOutputMode() { return (_singleFileForMT ? OutputMode::SINGLEFILE : OutputMode::MULTIFILE); }

private:
  GGSRootFileService();

  std::filesystem::path _GetAbsolutePath(const std::filesystem::path &baseName);
  std::filesystem::path _AppendSuffixAndExt(const std::filesystem::path &baseName, const G4Run *run);

  void _SetMultiFileMode();

  friend class GGSMultiUserAction;
  void _FillDefaultEventsTrees(); // Called by GGSMultiUserAction at end of event

  // Define the key class for indexing the transient volume index...
  struct VolumeKey {
    std::string name;
    const G4VPhysicalVolume *physVol;
    G4ThreeVector position;

    VolumeKey(const std::string &volName, const G4VPhysicalVolume *physVolPtr, const G4ThreeVector &pos)
        : name(volName), physVol(physVolPtr), position(pos) {}
    bool operator==(const VolumeKey &rhs) const {
      return (name == rhs.name && physVol == rhs.physVol && position == rhs.position);
    }

    friend struct std::hash<VolumeKey>;
  };
  // ... its hash struct (defined in the source file for GGSRootFileService) ...
  friend struct std::hash<VolumeKey>;

  // ... and the transient index itself.
  typedef std::unordered_map<VolumeKey, G4int, std::hash<VolumeKey>>
      HitVolMap; // <volume name, position in the GGSTHitDetInfo.volumes array>
  typedef std::list<std::pair<std::string, HitVolMap>> HitDetMap; // <detector name, index of volumes>

  // Define the class to store the info about the output file...
  struct FileInfo {
    std::filesystem::path absPath;
    std::unique_ptr<ROOT::TBufferMerger> bufferMerger; // For MT single-file mode
    HitDetMap detectorsMap;       // Transient index structure for fast searching during event processing.
    TClonesArray *detectorsArray; // Persistent detectors objects to be saved in this output file
    // Each file can have many associated TFiles in MT single-file mode, since bufferMerger will produce one TFile per
    // thread. So define a housekeeping struct for the TFiles (will be used also for the single TFile in ST mode or in
    // MT multi-file mode).
    struct TFileInfo {
      std::shared_ptr<TFile> tFile; // Must be destroyed after the buffer manager
      TTree *defaultEventsTree;
      int threadNo;
      int nRequests;
    };
    std::vector<TFileInfo> tFilesInfo; // Will have only 1 element in ST mode or in MT multi-file mode
  };
  // ... the file info container class...
  typedef std::list<FileInfo> FileInfoContainer;
  // ... and the container itself.
  FileInfoContainer _filesInfo;

  std::string _suffix;
  std::filesystem::path _defaultOutBase;
  bool _singleFileForMT;

  GGSTSimInfo _simInfo;

  G4GenericMessenger _messenger;

  // Variables used for performance in StoreVolume
  G4ThreadLocalStatic TFile *_currVolStorageTFile;
  G4ThreadLocalStatic std::string _currDetVolName;
  G4ThreadLocalStatic FileInfoContainer::iterator _currVolStorageFileInfo;
  G4ThreadLocalStatic HitDetMap::iterator _currDetector;
  G4ThreadLocalStatic GGSTHitDetInfo *_currPersDetector;
};

#endif /* GGSROOTFILESERVICE_H_ */