Core/Surfaces/SurfaceStub.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/Definitions/Algebra.hpp"
0012 #include "Acts/Geometry/GeometryContext.hpp"
0013 #include "Acts/Surfaces/InfiniteBounds.hpp"  //to get s_noBounds
0014 #include "Acts/Surfaces/PlanarBounds.hpp"
0015 #include "Acts/Surfaces/RegularSurface.hpp"
0016 #include "Acts/Surfaces/Surface.hpp"
0017 #include "Acts/Surfaces/SurfaceConcept.hpp"
0018 #include "Acts/Utilities/Intersection.hpp"
0019
0020 namespace ActsTests {
0021 /// Surface derived class stub
0022 class SurfaceStub : public Acts::RegularSurface {
0023  public:
0024   explicit SurfaceStub(
0025       const Acts::Transform3& htrans = Acts::Transform3::Identity())
0026       : Acts::GeometryObject(), Acts::RegularSurface(htrans) {}
0027   SurfaceStub(const Acts::GeometryContext& gctx, const SurfaceStub& sf,
0028               const Acts::Transform3& transf)
0029       : Acts::GeometryObject(), Acts::RegularSurface(gctx, sf, transf) {}
0030   explicit SurfaceStub(const Acts::SurfacePlacementBase& detelement)
0031       : Acts::GeometryObject(), Acts::RegularSurface(detelement) {}
0032
0033   ~SurfaceStub() override = default;
0034
0035   /// Return method for the Surface type to avoid dynamic casts
0036   Acts::Surface::SurfaceType type() const final { return Acts::Surface::Other; }
0037
0038   /// Return method for the normal vector of the surface
0039   Acts::Vector3 normal(const Acts::GeometryContext& /*gctx*/,
0040                        const Acts::Vector3& /*position*/) const final {
0041     return Acts::Vector3::Zero();
0042   }
0043
0044   Acts::Vector3 normal(const Acts::GeometryContext& /*gctx*/,
0045                        const Acts::Vector2& /*lposition*/) const final {
0046     return Acts::Vector3::Zero();
0047   }
0048
0049   using Acts::RegularSurface::normal;
0050
0051   /// Return method for SurfaceBounds
0052   const Acts::SurfaceBounds& bounds() const final {
0053     return Acts::s_noBounds;  // need to improve this for meaningful test
0054   }
0055
0056   /// Local to global transformation
0057   Acts::Vector3 localToGlobal(const Acts::GeometryContext& /*gctx*/,
0058                               const Acts::Vector2& /*lpos*/
0059   ) const final {
0060     return Acts::Vector3::Zero();
0061   }
0062
0063   using Acts::RegularSurface::localToGlobal;
0064
0065   /// Global to local transformation
0066   Acts::Result<Acts::Vector2> globalToLocal(
0067       const Acts::GeometryContext& /*cxt*/, const Acts::Vector3& /*gpos*/,
0068       double /*tolerance*/) const final {
0069     return Acts::Result<Acts::Vector2>::success(Acts::Vector2{20., 20.});
0070   }
0071
0072   using Acts::RegularSurface::globalToLocal;
0073
0074   /// Calculation of the path correction for incident
0075   double pathCorrection(const Acts::GeometryContext& /*cxt*/,
0076                         const Acts::Vector3& /*gpos*/,
0077                         const Acts::Vector3& /*gmom*/) const final {
0078     return 0.0;
0079   }
0080
0081   /// Inherited from GeometryObject base
0082   Acts::Vector3 referencePosition(const Acts::GeometryContext& /*txt*/,
0083                                   Acts::AxisDirection /*bValue*/) const final {
0084     return Acts::Vector3::Zero();
0085   }
0086
0087   /// Surface intersction
0088   Acts::MultiIntersection3D intersect(
0089       const Acts::GeometryContext& /*gctx*/, const Acts::Vector3& /*position*/,
0090       const Acts::Vector3& /*direction*/,
0091       const Acts::BoundaryTolerance& /*boundaryTolerance*/,
0092       const double /*tolerance*/) const final {
0093     Acts::Intersection3D stubIntersection(Acts::Vector3(20., 0., 0.), 20.,
0094                                           Acts::IntersectionStatus::reachable);
0095     return Acts::MultiIntersection3D(stubIntersection,
0096                                      Acts::Intersection3D::Invalid());
0097   }
0098
0099   /// Return properly formatted class name
0100   std::string name() const final { return std::string("SurfaceStub"); }
0101
0102   /// Simply return true to check a method can be called on a constructed object
0103   bool constructedOk() const { return true; }
0104
0105   /// Return a Polyhedron for the surfaces
0106   Acts::Polyhedron polyhedronRepresentation(
0107       const Acts::GeometryContext& /*gctx*/,
0108       unsigned int /* ignored */) const final {
0109     std::vector<Acts::Vector3> vertices;
0110     std::vector<std::vector<std::size_t>> faces;
0111     std::vector<std::vector<std::size_t>> triangularMesh;
0112
0113     return Acts::Polyhedron(vertices, faces, triangularMesh);
0114   }
0115
0116   // Cartesian 3D to local bound derivative
0117   Acts::Matrix<2, 3> localCartesianToBoundLocalDerivative(
0118       const Acts::GeometryContext& /*gctx*/,
0119       const Acts::Vector3& /*position*/) const final {
0120     return Acts::Matrix<2, 3>::Identity();
0121   };
0122
0123  private:
0124   /// the bounds of this surface
0125   std::shared_ptr<const Acts::PlanarBounds> m_bounds;
0126 };
0127
0128 static_assert(Acts::RegularSurfaceConcept<SurfaceStub>,
0129               "SurfaceStub does not fulfill RegularSurfaceConcept");
0130
0131 }  // namespace ActsTests