Acts/Propagator/NavigatorInitializeArguments.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/Definitions/Direction.hpp"
0013
0014 namespace Acts {
0015
0016 class Surface;
0017 class TrackingVolume;
0018
0019 /// Per-run inputs to the navigator initialization.
0020 ///
0021 /// A navigation state can serve more than one run, so everything that changes
0022 /// from run to run is passed here instead of through the navigator options.
0023 struct NavigatorInitializeArguments {
0024   /// Position the navigation run starts at
0025   Vector3 position{};
0026   /// Direction the navigation run starts with
0027   Vector3 direction{};
0028   /// Direction of the propagation along the trajectory
0029   Direction propagationDirection = Direction::Forward();
0030
0031   /// Surface the navigation run starts on, if any
0032   const Surface* startSurface = nullptr;
0033   /// Surface the navigation run targets, if any
0034   const Surface* targetSurface = nullptr;
0035   /// Hint for the start volume which short-cuts the volume search, if known
0036   const TrackingVolume* startVolume = nullptr;
0037 };
0038
0039 }  // namespace Acts