MaterialProperties.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file MaterialProperties.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 <iosfwd>
#include <vector>

#include "Acts/Material/Material.hpp"

namespace Acts {

class MaterialProperties {
 public:
  MaterialProperties() = default;
  MaterialProperties(float thickness);
  MaterialProperties(float X0, float L0, float Ar, float Z, float rho,
                     float thickness);
  MaterialProperties(const Material& material, float thickness);
  MaterialProperties(const std::vector<MaterialProperties>& layers);
  ~MaterialProperties() = default;

  MaterialProperties(MaterialProperties&& mprop) = default;
  MaterialProperties(const MaterialProperties&) = default;
  MaterialProperties& operator=(MaterialProperties&&) = default;
  MaterialProperties& operator=(const MaterialProperties&) = default;

  void scaleThickness(float scale);

  constexpr operator bool() const {
    return m_material and (0.0f < m_thickness);
  }

  constexpr const Material& material() const { return m_material; }
  constexpr float thickness() const { return m_thickness; }
  constexpr float thicknessInX0() const { return m_thicknessInX0; }
  constexpr float thicknessInL0() const { return m_thicknessInL0; }

 private:
  Material m_material;
  float m_thickness = 0.0f;
  float m_thicknessInX0 = 0.0f;
  float m_thicknessInL0 = 0.0f;

  friend constexpr bool operator==(const MaterialProperties& lhs,
                                   const MaterialProperties& rhs) {
    // t/X0 and t/L0 are dependent variables and need not be checked
    return (lhs.m_material == rhs.m_material) and
           (lhs.m_thickness == rhs.m_thickness);
  }
  friend constexpr bool operator!=(const MaterialProperties& lhs,
                                   const MaterialProperties& rhs) {
    return !(lhs == rhs);
  }
};

std::ostream& operator<<(std::ostream& os,
                         const MaterialProperties& materialProperties);

// Useful typedefs
using MaterialPropertiesVector = std::vector<MaterialProperties>;
using MaterialPropertiesMatrix = std::vector<MaterialPropertiesVector>;

}  // namespace Acts