KfDefs.h

Go to the documentation of this file.

/* Copyright (C) 2024 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergei Zharko [committer] */
 
 
#ifndef KF_CORE_KfDefs_h
#define KF_CORE_KfDefs_h 1
 
#include "KfSimd.h"
 
#include <array>
#include <functional>
#include <limits>
#include <tuple>
 
namespace cbm::algo::kf
{
  // ---- Enumerations -------------------------------------------------------------------------------------------------
  //
  enum class EFieldMode
  {
    Intrpl,  
    Orig     
  };
 
  // TODO: SZh 21.08.2024: Develope the concept of field types at different setup regions. At the moment the only
  //                       two global options are available.
  enum class EFieldType
  {
    Normal,  
    Null     
  };
 
  template<typename T>
  struct Literal {
    using type = T;
  };
 
  template<>
  struct Literal<fvec> {
    using type = fscal;
  };
 
  template<typename T>
  using Literal_t = typename Literal<T>::type;
 
 
  // ---- Common data types --------------------------------------------------------------------------------------------
  //
  template<class T>
  using GeoVector_t = std::array<T, 3>;
 
  using FieldFn_t = std::function<std::tuple<double, double, double>(double, double, double)>;
}  // namespace cbm::algo::kf
 
namespace cbm::algo::kf::defs
{
  // ----- Array sizes -------------------------------------------------------------------------------------------------
  //constexpr int MaxNofFieldSlices    = 64;  ///< Max number of field slices
  //constexpr int MaxNofMaterialLayers = 32;  ///< Max number of the material layers
  // NOTE: max uint8_t is assumed in order to satisfy fles::Subsystem
  constexpr int MaxNofDetSubsystems = 256;  
  constexpr int MaxNofDetComponents = 128;  
 
  // ----- Control -----------------------------------------------------------------------------------------------------
  constexpr int DebugLvl     = 0;     
  constexpr bool GetterCheck = true;  
 
 
  // ----- Math --------------------------------------------------------------------------------------------------------
  template<class T = double>
  constexpr auto Pi = Literal_t<T>(3.14159265358979323846L);  
 
  // ----- Physics -----------------------------------------------------------------------------------------------------
  template<class T = double>
  constexpr auto MuonMass = Literal_t<T>(0.105658375523L);  
 
  template<class T = double>
  constexpr auto PionMass = Literal_t<T>(0.1395703918L);  
 
  template<class T = double>
  constexpr auto KaonMass = Literal_t<T>(0.493677L);  
 
  template<class T = double>
  constexpr auto ElectronMass = Literal_t<T>(0.0005109989500015L);  
 
  template<class T = double>
  constexpr auto ProtonMass = Literal_t<T>(0.93827208816L);  
 
  template<class T = double>
  constexpr auto SpeedOfLight = Literal_t<T>(29.9792458L);  
 
  template<class T = double>
  constexpr auto SpeedOfLightInv = Literal_t<T>(1.L) / SpeedOfLight<T>;  
 
  template<class T = double>
  constexpr auto MinField = Literal_t<T>(1.e-4L);  
 
  // ----- Undefined values --------------------------------------------------------------------------------------------
  template<typename T1, typename T2 = T1>
  constexpr T2 Undef;
 
  template<>
  inline constexpr int Undef<int> = std::numeric_limits<int>::min();
 
  template<>
  inline constexpr unsigned Undef<unsigned> = std::numeric_limits<unsigned>::max();
 
  template<>
  inline constexpr float Undef<float> = std::numeric_limits<float>::signaling_NaN();
 
  template<>
  inline constexpr double Undef<double> = std::numeric_limits<double>::signaling_NaN();
 
  template<>
  inline constexpr fscal Undef<fvec> = std::numeric_limits<fscal>::signaling_NaN();
 
  // ----- Other -------------------------------------------------------------------------------------------------------
  constexpr auto ZeroFieldFn = [](double, double, double) constexpr { return std::make_tuple(0., 0., 0.); };
 
  // ----- Debug flags (NOTE: to be modified only by the experts) ------------------------------------------------------
  //
  namespace dbg
  {
  }  // namespace dbg
}  // namespace cbm::algo::kf::defs
 
#endif  // KF_CORE_KfDefs_h