ISurfaceMaterial.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file ISurfaceMaterial.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2016-2020 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once
#include <memory>
#include <vector>
#include "Acts/Geometry/GeometryID.hpp"
#include "Acts/Material/MaterialProperties.hpp"
#include "Acts/Utilities/Definitions.hpp"

namespace Acts {

class ISurfaceMaterial {
 public:
  ISurfaceMaterial() = default;

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

  virtual ~ISurfaceMaterial() = default;

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

  virtual const MaterialProperties& materialProperties(
      const Vector2D& lp) const = 0;

  virtual const MaterialProperties& materialProperties(
      const Vector3D& gp) const = 0;

  virtual const MaterialProperties& materialProperties(size_t ib0,
                                                       size_t ib1) const = 0;

  double factor(NavigationDirection pDir, MaterialUpdateStage mStage) const;

  MaterialProperties materialProperties(const Vector2D& lp,
                                        NavigationDirection pDir,
                                        MaterialUpdateStage mStage) const;

  MaterialProperties materialProperties(const Vector3D& gp,
                                        NavigationDirection pDir,
                                        MaterialUpdateStage mStage) const;

  friend std::ostream& operator<<(std::ostream& out,
                                  const ISurfaceMaterial& sm) {
    sm.toStream(out);
    return out;
  }

  virtual std::ostream& toStream(std::ostream& sl) const = 0;

 protected:
  double m_splitFactor{1.};  
};

inline double ISurfaceMaterial::factor(NavigationDirection pDir,
                                       MaterialUpdateStage mStage) const {
  if (mStage == Acts::fullUpdate) {
    return 1.;
  }
  return (pDir * mStage > 0 ? m_splitFactor : 1. - m_splitFactor);
}

inline MaterialProperties ISurfaceMaterial::materialProperties(
    const Vector2D& lp, NavigationDirection pDir,
    MaterialUpdateStage mStage) const {
  // The plain material properties associated to this bin
  MaterialProperties plainMatProp = materialProperties(lp);
  // Scale if you have material to scale
  if (plainMatProp) {
    double scaleFactor = factor(pDir, mStage);
    if (scaleFactor == 0.) {
      return MaterialProperties();
    }
    plainMatProp.scaleThickness(scaleFactor);
  }
  return plainMatProp;
}

inline MaterialProperties ISurfaceMaterial::materialProperties(
    const Vector3D& gp, NavigationDirection pDir,
    MaterialUpdateStage mStage) const {
  // The plain material properties associated to this bin
  MaterialProperties plainMatProp = materialProperties(gp);
  // Scale if you have material to scale
  if (plainMatProp) {
    double scaleFactor = factor(pDir, mStage);
    if (scaleFactor == 0.) {
      return MaterialProperties();
    }
    plainMatProp.scaleThickness(scaleFactor);
  }
  return plainMatProp;
}

}  // namespace Acts