Material.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Material.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 <limits>

#include "Acts/Utilities/Definitions.hpp"

namespace Acts {

class Material {
 public:
  enum Param {
    eX0 = 0,
    eL0 = 1,
    eAr = 2,
    eZ = 3,
    eRho = 4,
  };

  Material() = default;
  constexpr Material(float X0_, float L0_, float Ar_, float Z_, float rho_)
      : m_x0(X0_), m_l0(L0_), m_ar(Ar_), m_z(Z_), m_rho(rho_) {}
  Material(const ActsVectorF<5>& parameters);

  Material(Material&& mat) = default;
  Material(const Material& mat) = default;
  ~Material() = default;
  Material& operator=(Material&& mat) = default;
  Material& operator=(const Material& mat) = default;

  constexpr operator bool() const { return 0.0f < m_ar; }

  constexpr float X0() const { return m_x0; }
  constexpr float L0() const { return m_l0; }
  constexpr float Ar() const { return m_ar; }
  constexpr float Z() const { return m_z; }
  constexpr float massDensity() const { return m_rho; }
  float molarElectronDensity() const;
  float meanExcitationEnergy() const;

  ActsVectorF<5> classificationNumbers() const;

 private:
  float m_x0 = std::numeric_limits<float>::infinity();
  float m_l0 = std::numeric_limits<float>::infinity();
  float m_ar = 0.0f;
  float m_z = 0.0f;
  float m_rho = 0.0f;

  friend constexpr bool operator==(const Material& lhs, const Material& rhs) {
    return (lhs.m_x0 == rhs.m_x0) and (lhs.m_l0 == rhs.m_l0) and
           (lhs.m_ar == rhs.m_ar) and (lhs.m_z == rhs.m_z) and
           (lhs.m_rho == rhs.m_rho);
  }
  friend constexpr bool operator!=(const Material& lhs, const Material& rhs) {
    return !(lhs == rhs);
  }
};

std::ostream& operator<<(std::ostream& os, const Material& material);

}  // namespace Acts