Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Acts::PropagatorOptions< action_list_t, aborter_list_t > Struct Template Reference

Options for propagate() call. More...

#include <acts/blob/sPHENIX/Core/include/Acts/Propagator/Propagator.hpp>

+ Inheritance diagram for Acts::PropagatorOptions< action_list_t, aborter_list_t >:
+ Collaboration diagram for Acts::PropagatorOptions< action_list_t, aborter_list_t >:

Public Types

using action_list_type = action_list_t
 
using aborter_list_type = aborter_list_t
 

Public Member Functions

 PropagatorOptions ()=delete
 Delete default constructor.
 
 PropagatorOptions (const PropagatorOptions< action_list_t, aborter_list_t > &po)=default
 PropagatorOptions copy constructor.
 
 PropagatorOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx)
 PropagatorOptions with context.
 
template<typename extended_aborter_list_t >
PropagatorOptions
< action_list_t,
extended_aborter_list_t > 		extend (extended_aborter_list_t aborters) const
 Expand the Options with extended aborters.
 
void setPlainOptions (const PropagatorPlainOptions &pOptions)
 Set the plain options.
 

Public Attributes

action_list_t actionList
 List of actions.
 
aborter_list_t abortList
 List of abort conditions.
 
std::reference_wrapper< const
GeometryContext > 		geoContext
 The context object for the geometry.
 
std::reference_wrapper< const
MagneticFieldContext > 		magFieldContext
 The context object for the magnetic field.
 
- Public Attributes inherited from Acts::PropagatorPlainOptions
Direction direction = Direction::Forward
 Propagation direction.
 
unsigned int maxSteps = 1000
 Maximum number of steps for one propagate call.
 
unsigned int maxRungeKuttaStepTrials = 10000
 Maximum number of Runge-Kutta steps for the stepper step call.
 
double maxStepSize = std::numeric_limits<double>::max()
 Absolute maximum step size.
 
double pathLimit = std::numeric_limits<double>::max()
 Absolute maximum path length.
 
double targetTolerance = s_onSurfaceTolerance
 Required tolerance to reach target (surface, pathlength)
 
bool loopProtection = true
 Loop protection step, it adapts the pathLimit.
 
double loopFraction = 0.5
 Allowed loop fraction, 1 is a full loop.
 
double tolerance = 1e-4
 Tolerance for the error of the integration.
 
double stepSizeCutOff = 0.
 Cut-off value for the step size.
 

Detailed Description

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
struct Acts::PropagatorOptions< action_list_t, aborter_list_t >

Options for propagate() call.

Template Parameters
action_list_tList of action types called after each propagation step with the current propagation and stepper state
aborter_list_tList of abort conditions tested after each propagation step using the current propagation and stepper state

Definition at line 101 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 101 of file Propagator.hpp

Member Typedef Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
using Acts::PropagatorOptions< action_list_t, aborter_list_t >::aborter_list_type = aborter_list_t

Definition at line 103 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 103 of file Propagator.hpp

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
using Acts::PropagatorOptions< action_list_t, aborter_list_t >::action_list_type = action_list_t

Definition at line 102 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 102 of file Propagator.hpp

Constructor & Destructor Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( )
delete

Delete default constructor.

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( const PropagatorOptions< action_list_t, aborter_list_t > &  po)
default

PropagatorOptions copy constructor.

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
Acts::PropagatorOptions< action_list_t, aborter_list_t >::PropagatorOptions ( const GeometryContext &  gctx,
const MagneticFieldContext &  mctx 
)
inline

PropagatorOptions with context.

Definition at line 113 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 113 of file Propagator.hpp

Member Function Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
template<typename extended_aborter_list_t >
PropagatorOptions<action_list_t, extended_aborter_list_t> Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend ( extended_aborter_list_t  aborters) const
inline

Expand the Options with extended aborters.

Template Parameters
extended_aborter_list_tType of the new aborter list
Parameters
abortersThe new aborter list to be used (internally)

Definition at line 123 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 123 of file Propagator.hpp

References Acts::PropagatorOptions< action_list_t, aborter_list_t >::abortList, Acts::PropagatorOptions< action_list_t, aborter_list_t >::actionList, Acts::PropagatorPlainOptions::direction, Acts::PropagatorOptions< action_list_t, aborter_list_t >::geoContext, Acts::PropagatorPlainOptions::loopFraction, Acts::PropagatorPlainOptions::loopProtection, Acts::PropagatorOptions< action_list_t, aborter_list_t >::magFieldContext, Acts::PropagatorPlainOptions::maxRungeKuttaStepTrials, Acts::PropagatorPlainOptions::maxSteps, Acts::PropagatorPlainOptions::maxStepSize, testing::internal::move(), Acts::PropagatorPlainOptions::pathLimit, Acts::PropagatorPlainOptions::stepSizeCutOff, Acts::PropagatorPlainOptions::targetTolerance, and Acts::PropagatorPlainOptions::tolerance.

+ Here is the call graph for this function:

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
void Acts::PropagatorOptions< action_list_t, aborter_list_t >::setPlainOptions ( const PropagatorPlainOptions &  pOptions)
inline

Set the plain options.

Parameters
pOptionsThe plain options

Definition at line 150 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 150 of file Propagator.hpp

References Acts::PropagatorPlainOptions::direction, Acts::PropagatorPlainOptions::loopFraction, Acts::PropagatorPlainOptions::loopProtection, Acts::PropagatorPlainOptions::maxRungeKuttaStepTrials, Acts::PropagatorPlainOptions::maxSteps, Acts::PropagatorPlainOptions::maxStepSize, Acts::PropagatorPlainOptions::pathLimit, Acts::PropagatorPlainOptions::stepSizeCutOff, Acts::PropagatorPlainOptions::targetTolerance, and Acts::PropagatorPlainOptions::tolerance.

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, traj_t >::findTracks(), Acts::GaussianSumFitter< propagator_t, bethe_heitler_approx_t, traj_t >::fit(), and Acts::KalmanFitter< propagator_t, traj_t >::fit().

+ Here is the caller graph for this function:

Member Data Documentation

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
aborter_list_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::abortList

List of abort conditions.

Definition at line 168 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 168 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
action_list_t Acts::PropagatorOptions< action_list_t, aborter_list_t >::actionList

List of actions.

Definition at line 165 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 165 of file Propagator.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), Acts::Test::BOOST_DATA_TEST_CASE(), Acts::Test::createMeasurements(), Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend(), Acts::CombinatorialKalmanFilter< propagator_t, traj_t >::findTracks(), Acts::GaussianSumFitter< propagator_t, bethe_heitler_approx_t, traj_t >::fit(), Acts::Experimental::Gx2Fitter< propagator_t, traj_t >::fit(), and Acts::KalmanFitter< propagator_t, traj_t >::fit().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
std::reference_wrapper<const GeometryContext> Acts::PropagatorOptions< action_list_t, aborter_list_t >::geoContext

The context object for the geometry.

Definition at line 171 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 171 of file Propagator.hpp

Referenced by Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend().

template<typename action_list_t = ActionList<>, typename aborter_list_t = AbortList<>>
std::reference_wrapper<const MagneticFieldContext> Acts::PropagatorOptions< action_list_t, aborter_list_t >::magFieldContext

The context object for the magnetic field.

Definition at line 174 of file Propagator.hpp.

View newest version in sPHENIX GitHub at line 174 of file Propagator.hpp

Referenced by Acts::DenseStepperPropagatorOptions< action_list_t, aborter_list_t >::extend(), and Acts::PropagatorOptions< action_list_t, aborter_list_t >::extend().

The documentation for this struct was generated from the following file: