LayerMaterialProperties.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

// LayerMaterialProperties.h, (c) ATLAS Detector software
 
#ifndef TRKGEOMETY_LAYERMATERIALPROPERTIES_H
#define TRKGEOMETY_LAYERMATERIALPROPERTIES_H
 
// Amg
#include "GeoPrimitives/GeoPrimitives.h"
// Trk
 
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkGeometry/MaterialProperties.h"
 
// STD
#include <vector>
#include <iosfwd>
#include <memory>
 
class MsgStream;
class BinnedLayerMaterialCnv_p1;
 
namespace Trk {
 
class BinUtility;
class ElementTable;

 
enum MaterialConcentration { alongPre = 1, split = 0, oppositePre = -1 };

 
class LayerMaterialProperties {
 public:
  LayerMaterialProperties() = default;
  
  LayerMaterialProperties(const LayerMaterialProperties &) = default;
  LayerMaterialProperties(LayerMaterialProperties&&) noexcept= default;
  
  LayerMaterialProperties& operator=(const LayerMaterialProperties&) = default;
  LayerMaterialProperties& operator=(LayerMaterialProperties&&) noexcept = default;

  LayerMaterialProperties(double splitFactor) : m_splitFactor(splitFactor) {}

  virtual ~LayerMaterialProperties() = default;

  virtual LayerMaterialProperties* clone() const = 0;

  virtual LayerMaterialProperties& operator*=(double scale) = 0;

  virtual const MaterialProperties* fullMaterial(
      const Amg::Vector3D& gp) const = 0;

  virtual const MaterialProperties* material(size_t ib0, size_t ib1) const = 0;

  void updateElementTable(const std::shared_ptr<const ElementTable>&) const {}

  const ElementTable* elementTable() const { return nullptr; }

  double factor(PropDirection pDir, MaterialUpdateStage mStage) const;

  double alongPreFactor() const;

  double alongPostFactor() const;

  double oppositePreFactor() const;

  double oppositePostFactor() const;

  virtual const BinUtility* binUtility() const = 0;

  virtual void updateBinning(BinUtility* bu) = 0;

  virtual MsgStream& dump(MsgStream& sl) const = 0;

  virtual std::ostream& dump(std::ostream& sl) const = 0;
 
 protected:
  friend class ::BinnedLayerMaterialCnv_p1;
  double m_splitFactor{1.};  
};

inline double LayerMaterialProperties::factor(
    PropDirection pDir, MaterialUpdateStage mStage) const {
  if (mStage == Trk::fullUpdate) return 1.;
  return (static_cast<int>(pDir) * static_cast<int>(mStage) > 0 ?
          m_splitFactor : 1. - m_splitFactor);
}

inline double LayerMaterialProperties::alongPreFactor() const {
  return (1. - m_splitFactor);
}
 
inline double LayerMaterialProperties::alongPostFactor() const {
  return m_splitFactor;
}
 
inline double LayerMaterialProperties::oppositePreFactor() const {
  return m_splitFactor;
}
 
inline double LayerMaterialProperties::oppositePostFactor() const {
  return (1. - m_splitFactor);
}
 
//**Overload of << operator for both, MsgStream and std::ostream for debug
//output*/
 
MsgStream& operator<<(MsgStream& sl, const LayerMaterialProperties& mprop);
 
std::ostream& operator<<(std::ostream& sl,
                         const LayerMaterialProperties& mprop);
 
}  // namespace Trk
 
#endif  // TRKGEOMETY_LAYERMATERIALPROPERTIES_H