MaterialManager.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#include "DetectorsBase/MaterialManager.h"
#include "DetectorsBase/MaterialManagerParam.h"
#include "TVirtualMC.h"
#include "TString.h" // for TString
#include <TGeoMedium.h>
#include <TGeoManager.h>
#include <TList.h>
#include <iostream>
#include <utility>
#include <fairlogger/Logger.h>
#ifdef NDEBUG
#undef NDEBUG
#endif
#include <cassert>
#include <set>
#include "rapidjson/document.h"
#include "rapidjson/istreamwrapper.h"
#include "rapidjson/ostreamwrapper.h"
#include "rapidjson/prettywriter.h"
#include <algorithm>
#include <SimConfig/SimParams.h>
 
using namespace o2::base;
namespace rj = rapidjson;
 
namespace
{
template <typename K, typename V>
void writeSingleJSONParamBatch(std::unordered_map<K, const char*> const& idToName, std::map<K, V> const& valMap, V defaultValue, rapidjson::Value& parent, rapidjson::Document::AllocatorType& a)
{
  for (auto& itName : idToName) {
    auto itVal = valMap.find(itName.first);
    if (itVal != valMap.end()) {
      parent.AddMember(rj::Value(itName.second, std::strlen(itName.second), a), rj::Value(itVal->second), a);
      continue;
    }
    parent.AddMember(rj::Value(itName.second, std::strlen(itName.second), a), rj::Value(defaultValue), a);
  }
}
 
static constexpr const char* jsonKeyID = "local_id";
static constexpr const char* jsonKeyIDGlobal = "global_id";
static constexpr const char* jsonKeyDefault = "default";
static constexpr const char* jsonKeyCuts = "cuts";
static constexpr const char* jsonKeyProcesses = "processes";
static constexpr const char* jsonKeyEnableSpecialCuts = "enableSpecialCuts";
static constexpr const char* jsonKeyEnableSpecialProcesses = "enableSpecialProcesses";
} // namespace
 
const std::unordered_map<EProc, const char*> MaterialManager::mProcessIDToName = {
  {EProc::kPAIR, "PAIR"},
  {EProc::kCOMP, "COMP"},
  {EProc::kPHOT, "PHOT"},
  {EProc::kPFIS, "PFIS"},
  {EProc::kDRAY, "DRAY"},
  {EProc::kANNI, "ANNI"},
  {EProc::kBREM, "BREM"},
  {EProc::kHADR, "HADR"},
  {EProc::kMUNU, "MUNU"},
  {EProc::kDCAY, "DCAY"},
  {EProc::kLOSS, "LOSS"},
  {EProc::kMULS, "MULS"},
  {EProc::kCKOV, "CKOV"},
  {EProc::kRAYL, "RAYL"},
  {EProc::kLABS, "LABS"}};
 
const std::unordered_map<ECut, const char*> MaterialManager::mCutIDToName = {
  {ECut::kCUTGAM, "CUTGAM"},
  {ECut::kCUTELE, "CUTELE"},
  {ECut::kCUTNEU, "CUTNEU"},
  {ECut::kCUTHAD, "CUTHAD"},
  {ECut::kCUTMUO, "CUTMUO"},
  {ECut::kBCUTE, "BCUTE"},
  {ECut::kBCUTM, "BCUTM"},
  {ECut::kDCUTE, "DCUTE"},
  {ECut::kDCUTM, "DCUTM"},
  {ECut::kPPCUTM, "PPCUTM"},
  {ECut::kTOFMAX, "TOFMAX"}};
 
// Constructing a map between module names and local material density values
void MaterialManager::initDensityMap()
{
  auto& globalDensityFactor = o2::conf::SimMaterialParams::Instance().globalDensityFactor;
  if (globalDensityFactor < 0) {
    LOG(fatal) << "Negative value "
               << globalDensityFactor
               << " found for global material density!\n";
  }
  std::string token;
  std::istringstream input(
    o2::conf::SimMaterialParams::Instance().localDensityFactor);
  std::vector<std::string> inputModuleNames;
  std::vector<std::string> inputDensityValues;
  while (std::getline(input, token, ',')) {
    std::size_t pos = token.find(':');
    inputModuleNames.push_back(token.substr(0, pos));
    inputDensityValues.push_back(token.substr(pos + 1));
  }
  for (std::size_t i = 0; i < inputModuleNames.size(); i++) {
    if (std::stof(inputDensityValues[i]) < 0) {
      LOG(fatal) << "Negative value " << std::stof(inputDensityValues[i])
                 << " found for material density in module "
                 << inputModuleNames[i] << "!\n";
    }
    mDensityMap[inputModuleNames[i]] = std::stof(inputDensityValues[i]);
  }
  mDensityMapInitialized = true;
}
 
float MaterialManager::getDensity(std::string const& modname, std::string const& matname)
{
  // This function returns the final density for a material of name matname inside module modname.
  // The priority is
  // - return density for a specific module + material if it exists in the lookup
  // - return density for the module if it exists in the the lookup
  // - return global density factor
 
  auto debug = getenv("O2SIM_MATMGR_LOCALDENSITY_DEBUG");
 
  if (!mDensityMapInitialized) {
    initDensityMap();
  }
  // density on final material level
  // (this works by a name lookup of pair "modname/matname")
  std::string lookupstring = modname + "/" + matname;
  auto iter = mDensityMap.find(lookupstring);
  if (iter != mDensityMap.end()) {
    if (debug) {
      LOG(info) << "MatManager - " << modname << "/" << matname << " : applying density " << iter->second << " from material match";
    }
    return iter->second;
  }
  // density on module level
  iter = mDensityMap.find(modname);
  if (iter != mDensityMap.end()) {
    if (debug) {
      LOG(info) << "MatManager - " << modname << "/" << matname << " : applying density " << iter->second << " from module match";
    }
    return iter->second;
  }
  // global factor
  const auto global = o2::conf::SimMaterialParams::Instance().globalDensityFactor;
  if (debug && global != 1.0) {
    LOG(info) << "MatManager - " << modname << "/" << matname << " : applying global density " << iter->second;
  }
  return global;
}
 
void MaterialManager::Material(const char* modname, Int_t imat, const char* name, Float_t a, Float_t z, Float_t dens,
                               Float_t radl, Float_t absl, Float_t* buf, Int_t nwbuf)
{
  TString uniquename = modname;
  auto densityFactor = getDensity(modname, name);
 
  uniquename.Append("_");
  uniquename.Append(name);
  if (TVirtualMC::GetMC()) {
    // Check this!!!
    int kmat = -1;
    TVirtualMC::GetMC()->Material(kmat, uniquename.Data(), a, z,
                                  dens * densityFactor, radl, absl, buf, nwbuf);
    mMaterialMap[modname][imat] = kmat;
    insertMaterialName(uniquename.Data(), kmat);
  } else {
    auto uid = gGeoManager->GetListOfMaterials()->GetSize();
    auto mat = gGeoManager->Material(uniquename.Data(), a, z,
                                     dens * densityFactor, uid, radl, absl);
    mMaterialMap[modname][imat] = uid;
    insertMaterialName(uniquename.Data(), uid);
  }
}
 
void MaterialManager::Mixture(const char* modname, Int_t imat, const char* name, Float_t* a, Float_t* z, Float_t dens,
                              Int_t nlmat, Float_t* wmat)
{
  TString uniquename = modname;
  auto densityFactor = getDensity(modname, name);
  uniquename.Append("_");
  uniquename.Append(name);
 
  if (TVirtualMC::GetMC()) {
    // Check this!!!
    int kmat = -1;
    TVirtualMC::GetMC()->Mixture(kmat, uniquename.Data(), a, z,
                                 dens * densityFactor, nlmat, wmat);
    mMaterialMap[modname][imat] = kmat;
    insertMaterialName(uniquename.Data(), kmat);
 
  } else {
    auto uid = gGeoManager->GetListOfMaterials()->GetSize();
    if (nlmat < 0) {
      nlmat = -nlmat;
      Double_t amol = 0;
      Int_t i;
      for (i = 0; i < nlmat; i++) {
        amol += a[i] * wmat[i];
      }
      for (i = 0; i < nlmat; i++) {
        wmat[i] *= a[i] / amol;
      }
    }
    auto mix = gGeoManager->Mixture(uniquename.Data(), a, z,
                                    dens * densityFactor, nlmat, wmat, uid);
    mMaterialMap[modname][imat] = uid;
    insertMaterialName(uniquename.Data(), uid);
  }
}
 
void MaterialManager::Medium(const char* modname, Int_t numed, const char* name, Int_t nmat, Int_t isvol, Int_t ifield,
                             Float_t fieldm, Float_t tmaxfd, Float_t stemax, Float_t deemax, Float_t epsil,
                             Float_t stmin, Float_t* ubuf, Int_t nbuf)
{
  TString uniquename = modname;
  uniquename.Append("_");
  uniquename.Append(name);
 
  if (TVirtualMC::GetMC()) {
    // Check this!!!
    int kmed = -1;
    const int kmat = getMaterialID(modname, nmat);
    TVirtualMC::GetMC()->Medium(kmed, uniquename.Data(), kmat, isvol, ifield, fieldm, tmaxfd, stemax, deemax, epsil,
                                stmin, ubuf, nbuf);
    mMediumMap[modname][numed] = kmed;
    insertMediumName(uniquename.Data(), kmed);
    insertTGeoMedium(modname, numed);
  } else {
    auto uid = gGeoManager->GetListOfMedia()->GetSize();
    auto med = gGeoManager->Medium(uniquename.Data(), uid, getMaterialID(modname, nmat), isvol, ifield, fieldm, tmaxfd,
                                   stemax, deemax, epsil, stmin);
    mMediumMap[modname][numed] = uid;
    insertMediumName(uniquename.Data(), uid);
    insertTGeoMedium(modname, numed);
  }
}
 
void MaterialManager::Processes(ESpecial special, int globalindex,
                                const std::initializer_list<std::pair<EProc, int>>& parIDValMap)
{
  for (auto& m : parIDValMap) {
    Process(special, globalindex, m.first, m.second);
  }
}
 
void MaterialManager::Cuts(ESpecial special, int globalindex,
                           const std::initializer_list<std::pair<ECut, Float_t>>& parIDValMap)
{
  for (auto& m : parIDValMap) {
    Cut(special, globalindex, m.first, m.second);
  }
}
 
void MaterialManager::Cut(ESpecial special, int globalindex, ECut cut, Float_t val)
{
  // this check is needed, in principal only for G3, otherwise SegFault
  if (val < 0.) {
    return;
  }
  // if low energy neutron transport is requested setting kCUTNEU will set to 0.005eV
  if (mLowNeut && cut == ECut::kCUTNEU) {
    LOG(info) << "Due to low energy neutrons, neutron cut value " << val << " discarded and reset to 5e-12";
    val = 5.e-12;
  }
 
  auto it = mCutIDToName.find(cut);
  if (it == mCutIDToName.end()) {
    return;
  }
  if (special == ESpecial::kFALSE) {
    auto ins = mDefaultCutMap.insert({cut, val});
    if (ins.second) {
      TVirtualMC::GetMC()->SetCut(it->second, val);
    }
  } else if (mApplySpecialCuts) {
    auto ins = mMediumCutMap[globalindex].insert({cut, val});
    if (ins.second) {
      TVirtualMC::GetMC()->Gstpar(globalindex, it->second, val);
    }
  }
}
 
void MaterialManager::Process(ESpecial special, int globalindex, EProc process, int val)
{
  // this check is needed, in principal only for G3, otherwise SegFault
  if (val < 0) {
    return;
  }
  auto it = mProcessIDToName.find(process);
  if (it == mProcessIDToName.end()) {
    return;
  }
  if (special == ESpecial::kFALSE) {
    auto ins = mDefaultProcessMap.insert({process, val});
    if (ins.second) {
      TVirtualMC::GetMC()->SetProcess(it->second, val);
    }
  } else if (mApplySpecialProcesses) {
    auto ins = mMediumProcessMap[globalindex].insert({process, val});
    if (ins.second) {
      TVirtualMC::GetMC()->Gstpar(globalindex, it->second, val);
    }
  }
}
 
void MaterialManager::printMaterials() const
{
  for (auto& p : mMaterialMap) {
    auto name = p.first;
    std::cout << "Materials for key " << name << "\n";
    for (auto& e : p.second) {
      std::cout << "internal id " << e.first << " to " << e.second << "\n";
    }
  }
}
 
void MaterialManager::printMedia() const
{
  for (auto& p : mMediumMap) {
    auto name = p.first;
    std::cout << "Tracking media for key " << name << "\n";
    for (auto& e : p.second) {
      auto medname = getMediumNameFromMediumID(e.second);
      std::cout << medname << " ";
      std::cout << "internal id " << e.first << " to " << e.second << "\n";
    }
  }
}
 
void MaterialManager::printProcesses(std::ostream& stream) const
{
  stream << "Summary of process settings per media.\n";
  stream << "-- Default process settings:\n";
  for (auto& p : mDefaultProcessMap) {
    auto it = mProcessIDToName.find(p.first);
    if (it != mProcessIDToName.end()) {
      stream << "\t" << it->second << " = " << p.second << "\n";
    }
  }
  if (mApplySpecialProcesses && mMediumProcessMap.size() > 0) {
    stream << "-- Custom process settings for single media:\n";
    for (auto& m : mMediumProcessMap) {
      stream << "Global medium ID " << m.first << " (module = " << getModuleFromMediumID(m.first)
             << ", medium name = " << getMediumNameFromMediumID(m.first) << "):\n";
      for (auto& p : m.second) {
        auto it = mProcessIDToName.find(p.first);
        if (it != mProcessIDToName.end()) {
          stream << "\t" << it->second << " = " << p.second << "\n";
        }
      }
    }
  }
}
 
void MaterialManager::printCuts(std::ostream& stream) const
{
  stream << "Summary of cut settings per media.\n";
  stream << "-- Default cut settings:\n";
  for (auto& c : mDefaultCutMap) {
    auto it = mCutIDToName.find(c.first);
    if (it != mCutIDToName.end()) {
      stream << "\t" << it->second << " = " << c.second << "\n";
    }
  }
  if (mApplySpecialCuts && mMediumCutMap.size() > 0) {
    stream << "-- Custom cut settings for single media:\n";
    for (auto& m : mMediumCutMap) {
      stream << "Global medium ID " << m.first << " (module = " << getModuleFromMediumID(m.first)
             << ", medium name = " << getMediumNameFromMediumID(m.first) << "):\n";
      for (auto& c : m.second) {
        auto it = mCutIDToName.find(c.first);
        if (it != mCutIDToName.end()) {
          stream << "\t" << it->second << " = " << c.second << "\n";
        }
      }
    }
  }
}
 
// insert material name
void MaterialManager::insertMaterialName(const char* uniquename, int index)
{
  assert(mMaterialNameToGlobalIndexMap.find(uniquename) == mMaterialNameToGlobalIndexMap.end());
  mMaterialNameToGlobalIndexMap[uniquename] = index;
}
 
// inserts the last
void MaterialManager::insertTGeoMedium(std::string modname, int localindex)
{
  auto p = std::make_pair(modname, localindex);
  assert(mTGeoMediumMap.find(p) == mTGeoMediumMap.end());
  auto list = gGeoManager->GetListOfMedia();
  mTGeoMediumMap[p] = (TGeoMedium*)list->At(list->GetEntries() - 1);
 
  LOG(debug) << "mapping " << modname << " " << localindex << " to " << mTGeoMediumMap[p]->GetName();
}
 
void MaterialManager::insertMediumName(const char* uniquename, int index)
{
  assert(mMediumNameToGlobalIndexMap.find(uniquename) == mMediumNameToGlobalIndexMap.end());
  mMediumNameToGlobalIndexMap[uniquename] = index;
}
 
// find TGeoMedium instance given a detector prefix and a local (vmc) medium index
TGeoMedium* MaterialManager::getTGeoMedium(std::string const& modname, int localindex)
{
  auto p = std::make_pair(modname, localindex);
  auto iter = mTGeoMediumMap.find(p);
  if (iter == mTGeoMediumMap.end()) {
    LOG(warning) << "No medium registered for " << modname << " index " << localindex << "\n";
    return nullptr;
  }
  return iter->second;
}
 
// find TGeoMedium instance given the full medium name
// mainly forwards directly to TGeoManager and raises a warning if medium is nullptr
TGeoMedium* MaterialManager::getTGeoMedium(const char* mediumname)
{
  auto med = gGeoManager->GetMedium(mediumname);
  assert(med != nullptr);
  return med;
}
 
void MaterialManager::loadCutsAndProcessesFromJSON(ESpecial special, std::string const& filename)
{
  const std::string filenameIn = filename.empty() ? o2::MaterialManagerParam::Instance().inputFile : filename;
  if (filenameIn.empty()) {
    return;
  }
  std::ifstream is(filenameIn);
  if (!is.is_open()) {
    LOG(fatal) << "Cannot open MC cuts/processes file " << filenameIn;
    return;
  }
  auto digestCutsFromJSON = [this](int globalindex, rj::Value& cuts) {
    auto special = globalindex < 0 ? ESpecial::kFALSE : ESpecial::kTRUE;
    for (auto& cut : cuts.GetObject()) {
      auto name = cut.name.GetString();
      bool found = false;
      for (auto& cn : mCutIDToName) {
        if (std::strcmp(name, cn.second) == 0) {
          Cut(special, globalindex, cn.first, cut.value.GetFloat());
          found = true;
        }
      }
      if (!found) {
        LOG(warn) << "Unknown cut parameter " << name;
      }
    }
  };
  auto digestProcessesFromJSON = [this](int globalindex, rj::Value& processes) {
    auto special = globalindex < 0 ? ESpecial::kFALSE : ESpecial::kTRUE;
    for (auto& proc : processes.GetObject()) {
      auto name = proc.name.GetString();
      for (auto& pn : mProcessIDToName) {
        if (std::strcmp(name, pn.second) == 0) {
          Process(special, globalindex, pn.first, proc.value.GetInt());
        }
      }
    }
  };
 
  rj::IStreamWrapper isw(is);
  rj::Document d;
  d.ParseStream(isw);
 
  if (special == ESpecial::kFALSE && d.HasMember(jsonKeyDefault)) {
    // defaults
    auto& defaultParams = d[jsonKeyDefault];
    if (defaultParams.HasMember(jsonKeyCuts)) {
      digestCutsFromJSON(-1, defaultParams[jsonKeyCuts]);
    }
    if (defaultParams.HasMember(jsonKeyProcesses)) {
      digestProcessesFromJSON(-1, defaultParams[jsonKeyProcesses]);
    }
  } else if (special == ESpecial::kTRUE) {
    // read whether to apply special cuts and processes at all
    if (d.HasMember(jsonKeyEnableSpecialCuts)) {
      enableSpecialCuts(d[jsonKeyEnableSpecialCuts].GetBool());
    }
    if (d.HasMember(jsonKeyEnableSpecialProcesses)) {
      enableSpecialProcesses(d[jsonKeyEnableSpecialProcesses].GetBool());
    }
    // special
    for (auto& m : d.GetObject()) {
      if (m.name.GetString()[0] == '\0' || !m.value.IsArray()) {
        // do not parse anything with empty key, these at the most meant to be comments
        continue;
      }
      for (auto& batch : m.value.GetArray()) {
        if (std::strcmp(m.name.GetString(), jsonKeyDefault) == 0) {
          // don't do defaults here
          continue;
        }
        // set via their global indices
        auto index = getMediumID(m.name.GetString(), batch[jsonKeyID].GetInt());
        if (index < 0) {
          continue;
        }
        if (batch.HasMember(jsonKeyCuts)) {
          digestCutsFromJSON(index, batch[jsonKeyCuts]);
        }
        if (batch.HasMember(jsonKeyProcesses)) {
          digestProcessesFromJSON(index, batch[jsonKeyProcesses]);
        }
      }
    }
  }
}
 
void MaterialManager::writeCutsAndProcessesToJSON(std::string const& filename)
{
  const std::string filenameOut = filename.empty() ? o2::MaterialManagerParam::Instance().outputFile : filename;
  if (filenameOut.empty()) {
    return;
  }
 
  // write parameters as global AND module specific
  std::ofstream os(filenameOut);
  if (!os.is_open()) {
    LOG(error) << "Cannot create file " << filenameOut;
    return;
  }
 
  rj::Document d;
  rj::Document::AllocatorType& a = d.GetAllocator();
  d.SetObject();
 
  // add each local medium with params per module
  for (auto& itMed : mMediumMap) {
    // prepare array for module
    rj::Value toAdd(rj::kArrayType);
    // extract each medium's local and global index
    for (auto& locToGlob : itMed.second) {
      auto globalindex = locToGlob.second;
      auto itCut = mMediumCutMap.find(globalindex);
      auto itProc = mMediumProcessMap.find(globalindex);
      // prepare a batch summarising localID, globaldID, cuts and processes
      rj::Value oLoc(rj::kObjectType);
      // IDs
      oLoc.AddMember(rj::Value(jsonKeyID, std::strlen(jsonKeyID), a), rj::Value(locToGlob.first), a);
      oLoc.AddMember(rj::Value(jsonKeyIDGlobal, std::strlen(jsonKeyIDGlobal)), rj::Value(locToGlob.second), a);
      // add medium and material name
      auto mediumIt = mTGeoMediumMap.find({itMed.first, locToGlob.first});
      const char* medName = mediumIt->second->GetName();
      const char* matName = mediumIt->second->GetMaterial()->GetName();
      // not using variables for key names cause they are only written for info but not read
      oLoc.AddMember(rj::Value("medium_name", 11, a), rj::Value(medName, std::strlen(medName), a), a);
      oLoc.AddMember(rj::Value("material_name", 13, a), rj::Value(matName, std::strlen(matName), a), a);
      // prepare for cuts
      if (itCut != mMediumCutMap.end()) {
        rj::Value cutMap(rj::kObjectType);
        writeSingleJSONParamBatch(mCutIDToName, itCut->second, -1.f, cutMap, a);
        oLoc.AddMember(rj::Value(jsonKeyCuts, std::strlen(jsonKeyCuts), a), cutMap, a);
      }
      // prepare for processes
      if (itProc != mMediumProcessMap.end()) {
        rj::Value procMap(rj::kObjectType);
        writeSingleJSONParamBatch(mProcessIDToName, itProc->second, -1, procMap, a);
        oLoc.AddMember(rj::Value(jsonKeyProcesses, std::strlen(jsonKeyProcesses), a), procMap, a);
      }
      // append this medium to module array
      toAdd.PushBack(oLoc, a);
    }
    // append the entire module array
    d.AddMember(rj::Value(itMed.first.c_str(), itMed.first.size(), a), toAdd, a);
  }
  // also add default parameters
  rj::Value cutMapDef(rj::kObjectType);
  rj::Value procMapDef(rj::kObjectType);
  writeSingleJSONParamBatch(mCutIDToName, mDefaultCutMap, -1.f, cutMapDef, a);
  writeSingleJSONParamBatch(mProcessIDToName, mDefaultProcessMap, -1, procMapDef, a);
  rj::Value defaultParams(rj::kObjectType);
  defaultParams.AddMember(rj::Value(jsonKeyCuts, std::strlen(jsonKeyCuts), a), cutMapDef, a);
  defaultParams.AddMember(rj::Value(jsonKeyProcesses, std::strlen(jsonKeyProcesses), a), procMapDef, a);
  d.AddMember(rj::Value(jsonKeyDefault, std::strlen(jsonKeyDefault), a), defaultParams, a);
 
  d.AddMember(rj::Value(jsonKeyEnableSpecialCuts, std::strlen(jsonKeyEnableSpecialCuts), a), rj::Value(mApplySpecialCuts), a);
  d.AddMember(rj::Value(jsonKeyEnableSpecialProcesses, std::strlen(jsonKeyEnableSpecialProcesses), a), rj::Value(mApplySpecialProcesses), a);
  // now write to file
  rj::OStreamWrapper osw(os);
  rj::PrettyWriter<rj::OStreamWrapper> writer(osw);
  writer.SetIndent(' ', 2);
  d.Accept(writer);
}
 
void MaterialManager::loadCutsAndProcessesFromFile(const char* modname, const char* filename)
{
  // Implementation of a method to set cuts and processes as done in AliRoot.
  // The file is expected to contain columns of the form
  // MODNAME LOCALMEDIUMID CUT0 ... CUT9 FLAG0 ... FLAG11
  // where cuts and flags correspond to keys denoted in cutnames and procnames below.
 
  const int NCUTS = 10;  // number of cut columns expected in file
  const int NFLAGS = 12; // number of process flag columns expected in file
 
  using namespace o2::base;
  ECut cutnames[NCUTS] = {ECut::kCUTGAM,
                          ECut::kCUTELE,
                          ECut::kCUTNEU,
                          ECut::kCUTHAD,
                          ECut::kCUTMUO,
                          ECut::kBCUTE,
                          ECut::kBCUTM,
                          ECut::kDCUTE,
                          ECut::kDCUTM,
                          ECut::kPPCUTM};
 
  // missing STRA for the moment
  EProc procnames[NFLAGS - 1] = {EProc::kANNI,
                                 EProc::kBREM,
                                 EProc::kCOMP,
                                 EProc::kDCAY,
                                 EProc::kDRAY,
                                 EProc::kHADR,
                                 EProc::kLOSS,
                                 EProc::kMULS,
                                 EProc::kPAIR,
                                 EProc::kPHOT,
                                 EProc::kRAYL};
 
  std::ifstream cutfile(filename);
 
  if (!cutfile.is_open()) {
    LOG(warn) << "File " << filename << " does not exist; Cannot apply cuts";
    return;
  }
 
  // reading from file
  float cut[NCUTS]; // to store cut values
  int flag[NFLAGS]; // to store flags
  int itmed, iret;
  char line[256];
  char detName[7];
 
  while (cutfile.getline(line, 256)) {
    // Initialise cuts and flags for this line
    for (int i = 0; i < NCUTS; i++) {
      cut[i] = -99;
    }
    for (int i = 0; i < NFLAGS; i++) {
      flag[i] = -99;
    }
    if (strlen(line) == 0) {
      continue;
    }
    // ignore comments marked by *
    if (line[0] == '*') {
      continue;
    }
    // Read the numbers
    iret = sscanf(line, "%6s %d %f %f %f %f %f %f %f %f %f %f %d %d %d %d %d %d %d %d %d %d %d %d",
                  detName, &itmed, &cut[0], &cut[1], &cut[2], &cut[3], &cut[4], &cut[5], &cut[6], &cut[7], &cut[8],
                  &cut[9], &flag[0], &flag[1], &flag[2], &flag[3], &flag[4], &flag[5], &flag[6], &flag[7],
                  &flag[8], &flag[9], &flag[10], &flag[11]);
    if (!iret) {
      // nothing read
      continue;
    }
 
    // apply cuts via material manager interface
    for (int i = 0; i < NCUTS; ++i) {
      if (cut[i] >= 0.) {
        SpecialCut(detName, itmed, cutnames[i], cut[i]);
      }
    }
 
    // apply process flags
    for (int i = 0; i < NFLAGS - 1; ++i) {
      if (flag[i] >= 0) {
        SpecialProcess(detName, itmed, procnames[i], flag[i]);
      }
    }
  } // end loop over lines
}
 
void MaterialManager::SpecialCuts(const char* modname, int localindex,
                                  const std::initializer_list<std::pair<ECut, Float_t>>& parIDValMap)
{
  int globalindex = getMediumID(modname, localindex);
  if (globalindex != -1) {
    Cuts(ESpecial::kTRUE, globalindex, parIDValMap);
  }
}
 
void MaterialManager::SpecialCut(const char* modname, int localindex, ECut parID, Float_t val)
{
  int globalindex = getMediumID(modname, localindex);
  if (globalindex != -1) {
    Cut(ESpecial::kTRUE, globalindex, parID, val);
  } else {
    LOG(warn) << "SpecialCut: NO GLOBALINDEX FOUND FOR " << modname << " " << localindex;
  }
}
 
void MaterialManager::SpecialProcess(const char* modname, int localindex, EProc parID, int val)
{
  int globalindex = getMediumID(modname, localindex);
  if (globalindex != -1) {
    Process(ESpecial::kTRUE, globalindex, parID, val);
  } else {
    LOG(warn) << "SpecialProcess: NO GLOBALINDEX FOUND FOR " << modname << " " << localindex;
  }
}
 
int MaterialManager::getMaterialID(const char* modname, int imat) const
{
  auto lookupiter = mMaterialMap.find(modname);
  if (lookupiter == mMaterialMap.end()) {
    return -1;
  }
  auto lookup = lookupiter->second;
 
  auto iter = lookup.find(imat);
  if (iter != lookup.end()) {
    return iter->second;
  }
  return -1;
}
 
int MaterialManager::getMediumID(const char* modname, int imed) const
{
  auto lookupiter = mMediumMap.find(modname);
  if (lookupiter == mMediumMap.end()) {
    return -1;
  }
  auto lookup = lookupiter->second;
 
  auto iter = lookup.find(imed);
  if (iter != lookup.end()) {
    return iter->second;
  }
  return -1;
}
 
// fill the medium index mapping into a standard vector
// the vector gets sized properly and will be overridden
void MaterialManager::getMediumIDMappingAsVector(const char* modname, std::vector<int>& mapping) const
{
  mapping.clear();
 
  auto lookupiter = mMediumMap.find(modname);
  if (lookupiter == mMediumMap.end()) {
    return;
  }
  auto lookup = lookupiter->second;
 
  // get the biggest mapped value (maps are sorted in keys)
  auto maxkey = lookup.rbegin()->first;
  // resize mapping and initialize with -1 by default
  mapping.resize(maxkey + 1, -1);
  // fill vector with entries from map
  for (auto& p : lookup) {
    mapping[p.first] = p.second;
  }
}
 
void MaterialManager::getMediaWithSpecialProcess(EProc process, std::vector<int>& mediumProcessVector) const
{
  // clear
  mediumProcessVector.clear();
  // resize to maximum number of global IDs for which special processes are set. In case process is not
  // implemented for a certain medium, value is -1
  mediumProcessVector.resize(mMediumProcessMap.size(), -1);
  // find media
  for (auto& m : mMediumProcessMap) {
    // loop over processes in medium
    for (auto& p : m.second) {
      // push medium ID if process is there
      if (p.first == process) {
        mediumProcessVector[m.first] = p.second;
        break;
      }
    }
  }
}
 
void MaterialManager::getMediaWithSpecialCut(ECut cut, std::vector<Float_t>& mediumCutVector) const
{
  // clear
  mediumCutVector.clear();
  // resize to maximum number of global IDs for which special cuts are set. In case cut is not implemented
  // for a certain medium, value is -1.
  mediumCutVector.resize(mMediumCutMap.size(), -1.);
  // find media
  for (auto& m : mMediumCutMap) {
    // loop over cuts in medium
    for (auto& c : m.second) {
      // push medium ID if cut is there
      if (c.first == cut) {
        mediumCutVector[m.first] = c.second;
        break;
      }
    }
  }
}
 
void MaterialManager::getDefaultProcesses(std::vector<std::pair<EProc, int>>& processVector)
{
  processVector.clear();
  for (auto& m : mDefaultProcessMap) {
    processVector.emplace_back(m.first, m.second);
  }
}
void MaterialManager::getDefaultCuts(std::vector<std::pair<ECut, Float_t>>& cutVector)
{
  cutVector.clear();
  for (auto& m : mDefaultCutMap) {
    cutVector.emplace_back(m.first, m.second);
  }
}
void MaterialManager::getSpecialProcesses(int globalindex, std::vector<std::pair<EProc, int>>& processVector)
{
  processVector.clear();
  if (mMediumProcessMap.find(globalindex) != mMediumProcessMap.end()) {
    for (auto& m : mMediumProcessMap[globalindex]) {
      processVector.emplace_back(m.first, m.second);
    }
  }
}
void MaterialManager::getSpecialProcesses(const char* modname, int localindex, std::vector<std::pair<EProc, int>>& processVector)
{
  int globalindex = getMediumID(modname, localindex);
  if (globalindex != -1) {
    getSpecialProcesses(globalindex, processVector);
  }
}
void MaterialManager::getSpecialCuts(int globalindex, std::vector<std::pair<ECut, Float_t>>& cutVector)
{
  cutVector.clear();
  if (mMediumCutMap.find(globalindex) != mMediumCutMap.end()) {
    for (auto& m : mMediumCutMap[globalindex]) {
      cutVector.emplace_back(m.first, m.second);
    }
  }
}
void MaterialManager::getSpecialCuts(const char* modname, int localindex, std::vector<std::pair<ECut, Float_t>>& cutVector)
{
  int globalindex = getMediumID(modname, localindex);
  if (globalindex != -1) {
    getSpecialCuts(globalindex, cutVector);
  }
}
 
const char* MaterialManager::getModuleFromMediumID(int globalindex) const
{
  // loop over module names and corresponding local<->global mapping
  for (auto& m : mMediumMap) {
    for (auto& i : m.second) {
      // is the global index there?
      if (i.second == globalindex) {
        // \note maybe unsafe in case mMediumMap is altered in the same scope where the returned C string is used
        // since that points to memory of string it was derived from.
        return m.first.c_str();
      }
    }
  }
  // module is UNKNOWN if global medium ID could not be found.
  return "UNKNOWN";
}
 
const char* MaterialManager::getMediumNameFromMediumID(int globalindex) const
{
  // Get the name of the medium.
  // TODO: avoid linear search
  for (auto& n : mMediumNameToGlobalIndexMap) {
    if (n.second == globalindex) {
      // \note maybe unsafe in case mMediumMap is altered in the same scope where the returned C string is used since
      // that points to memory of string it was derived from.
      return n.first.c_str();
    }
  }
  return "UNKNOWN";
}
 
void MaterialManager::printContainingMedia(std::string const& volumename)
{
  auto vol = gGeoManager->FindVolumeFast(volumename.c_str());
  if (vol == nullptr) {
    LOG(warn) << "No volume found; Cannot query medias";
  }
  std::set<TGeoMedium const*> media;
 
  // a little well encapsulated helper to code the recursive visitor
  // pure lambda cannot be recursive
  std::function<void(TGeoVolume const* vol, std::set<TGeoMedium const*>& mediumset)> recursivevisitor;
  recursivevisitor = [&recursivevisitor](TGeoVolume const* vol, std::set<TGeoMedium const*>& mediumset) {
    // exclude assemblies
    if (!vol->IsAssembly()) {
      mediumset.insert(vol->GetMedium());
    }
    const int n = vol->GetNdaughters();
    for (int i = 0; i < n; ++i) {
      auto daughter = vol->GetNode(i)->GetVolume();
      recursivevisitor(daughter, mediumset);
    }
  };
  recursivevisitor(vol, media);
 
  // simply print the media
  for (auto m : media) {
    std::cout << m->GetName() << "\n";
  }
}
 
ClassImp(o2::base::MaterialManager);