Material/detail/AverageMaterials.hpp

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008
0009 #pragma once
0010
0011 #include "Acts/Material/MaterialSlab.hpp"
0012
0013 namespace Acts::detail {
0014
0015 /// Compute the average properties for a combined slab of two materials.
0016 ///
0017 /// The averaged material slab has the combined thickness of the two input slabs
0018 /// and assumes the two input materials are homogeneously and continuously mixed
0019 /// throughout the slab.
0020 ///
0021 /// @param slab1 Properties of the first material slab
0022 /// @param slab2 Properties of the second material slab
0023 ///
0024 /// @returns Material slab with the combined thickness and average parameters
0025 MaterialSlab combineSlabs(const MaterialSlab& slab1, const MaterialSlab& slab2);
0026
0027 /// Compute the average properties for a combined slab of two materials.
0028 ///
0029 /// The averaged material slab has the combined thickness of the two input slabs
0030 /// and assumes the two input materials are homogeneously and continuously mixed
0031 /// throughout the slab.
0032 ///
0033 /// @param slab1 Properties of the first material slab
0034 /// @param material2 Properties of the second material
0035 /// @param thickness2 Thickness of the second material slab. Can be negative to
0036 ///                   subtract the second material from the first slab.
0037 ///
0038 /// @returns Material slab with the combined thickness and average parameters
0039 MaterialSlab combineSlabs(const MaterialSlab& slab1, const Material& material2,
0040                           float thickness2);
0041
0042 }  // namespace Acts::detail