TFCSParametrizationBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_FASTCALOSIMEVENT_TFCSParametrizationBase_h
#define ISF_FASTCALOSIMEVENT_TFCSParametrizationBase_h
 
#include <set>
#include <map>
#include <mutex>
 
#include "CxxUtils/checker_macros.h"
#include "ISF_FastCaloSimEvent/MLogging.h"
 
class ICaloGeometry;
class TFCSSimulationState;
class TFCSTruthState;
class TFCSExtrapolationState;


enum FCSReturnCode { FCSFatal = 0, FCSSuccess = 1, FCSRetry = 2 };
 
#define FCS_RETRY_COUNT 3
 
 
class TFCSParametrizationBase : public TNamed, public ISF_FCS::MLogging {
public:
  TFCSParametrizationBase(const char *name = nullptr,
                          const char *title = nullptr);

  enum FCSStatusBits {
    kMatchAllPDGID = BIT(
        14) 
  };
 
  virtual bool is_match_pdgid(int /*id*/) const {
    return TestBit(kMatchAllPDGID);
  };
  virtual bool is_match_Ekin(float /*Ekin*/) const { return false; };
  virtual bool is_match_eta(float /*eta*/) const { return false; };
 
  virtual bool is_match_Ekin_bin(int /*Ekin_bin*/) const { return false; };
  virtual bool is_match_calosample(int /*calosample*/) const { return false; };
 
  virtual bool is_match_all_pdgid() const { return TestBit(kMatchAllPDGID); };
  virtual bool is_match_all_Ekin() const { return false; };
  virtual bool is_match_all_eta() const { return false; };
  virtual bool is_match_all_Ekin_bin() const { return false; };
  virtual bool is_match_all_calosample() const { return false; };
 
  virtual const std::set<int> &pdgid() const {
    static const std::set<int> empty;
    return empty;
  };
  virtual double Ekin_nominal() const { return init_Ekin_nominal; };
  virtual double Ekin_min() const { return init_Ekin_min; };
  virtual double Ekin_max() const { return init_Ekin_max; };
  virtual double eta_nominal() const { return init_eta_nominal; };
  virtual double eta_min() const { return init_eta_min; };
  virtual double eta_max() const { return init_eta_max; };
 
  virtual void set_match_all_pdgid() { SetBit(kMatchAllPDGID); };
  virtual void reset_match_all_pdgid() { ResetBit(kMatchAllPDGID); };

  virtual void set_geometry(ICaloGeometry *geo);

  virtual unsigned int size() const { return 0; };

  virtual const TFCSParametrizationBase *
  operator[](unsigned int /*ind*/) const {
    return nullptr;
  };

  virtual TFCSParametrizationBase *operator[](unsigned int /*ind*/) {
    return nullptr;
  };

  virtual void set_daughter(unsigned int /*ind*/,
                            TFCSParametrizationBase * /*param*/){};

  virtual bool operator==(const TFCSParametrizationBase &ref) const {
    return compare(ref);
  };

  virtual FCSReturnCode simulate(TFCSSimulationState &simulstate,
                                 const TFCSTruthState *truth,
                                 const TFCSExtrapolationState *extrapol) const;

  virtual void CleanAuxInfo(TFCSSimulationState & /*simulstate*/) const {};

  void Print(Option_t *option = "") const;
 
 
  struct Duplicate_t {
    TFCSParametrizationBase *replace = nullptr;
    std::vector<TFCSParametrizationBase *> mother;
    std::vector<unsigned int> index;
  };
  typedef std::map<TFCSParametrizationBase *, Duplicate_t> FindDuplicates_t;
  typedef std::map<std::string, FindDuplicates_t> FindDuplicateClasses_t;
  void FindDuplicates(FindDuplicateClasses_t &dup);
  void RemoveDuplicates();
  void RemoveNameTitle();
 
#ifdef USE_GPU
  // will not compile by default
  void Copy2GPU(); // copy all the paramterization files to GPU
#endif
 
protected:
  static constexpr double init_Ekin_nominal = 0;    
  static constexpr double init_Ekin_min = 0;        
  static constexpr double init_Ekin_max = 14000000; 
  static constexpr double init_eta_nominal = 0;     
  static constexpr double init_eta_min = -100;      
  static constexpr double init_eta_max = 100;       
 
 
  bool compare(const TFCSParametrizationBase &ref) const;
 
#if defined(__FastCaloSimStandAlone__)
public:
  using MLogging::setLevel;
  virtual void setLevel(int level, bool recursive) {
    this->setLevel(level);
    if (recursive)
      for (unsigned int i = 0; i < size(); ++i)
        (*this)[i]->setLevel(level, recursive);
  }
#endif
 
private:
 
  ClassDef(TFCSParametrizationBase, 3) // TFCSParametrizationBase
};
 
#endif // End header guards