Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::SurfaceReached Struct Reference

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

Public Member Functions

 SurfaceReached ()=default
 
 SurfaceReached (double oLimit)
 
template<typename propagator_state_t , typename stepper_t , typename navigator_t >
bool operator() (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, const Logger &logger) const
 
template<typename propagator_state_t , typename stepper_t , typename navigator_t >
bool operator() (propagator_state_t &state, const stepper_t &stepper, const navigator_t &navigator, const Surface &targetSurface, const Logger &logger) const
 

Public Attributes

std::optional< doubleoverstepLimit
 

Detailed Description

This is the condition that the Surface has been reached it then triggers an propagation abort of the propagation

Definition at line 90 of file StandardAborters.hpp.

View newest version in sPHENIX GitHub at line 90 of file StandardAborters.hpp

Constructor & Destructor Documentation

Acts::SurfaceReached::SurfaceReached ( )
default
Acts::SurfaceReached::SurfaceReached ( double  oLimit)
inline

Definition at line 94 of file StandardAborters.hpp.

View newest version in sPHENIX GitHub at line 94 of file StandardAborters.hpp

Member Function Documentation

template<typename propagator_state_t , typename stepper_t , typename navigator_t >
bool Acts::SurfaceReached::operator() ( propagator_state_t &  state,
const stepper_t &  stepper,
const navigator_t &  navigator,
const Logger logger 
) const
inline

boolean operator for abort condition without using the result

Template Parameters
propagator_state_tType of the propagator state
stepper_tType of the stepper
navigator_tType of the navigator
Parameters
[in,out]stateThe propagation state object
[in]stepperStepper used for propagation
[in]navigatorNavigator used for propagation
loggera logger instance

Definition at line 108 of file StandardAborters.hpp.

View newest version in sPHENIX GitHub at line 108 of file StandardAborters.hpp

References logger(), Acts::Test::navigator, filter::state, and propagation_timing::stepper.

+ Here is the call graph for this function:

template<typename propagator_state_t , typename stepper_t , typename navigator_t >
bool Acts::SurfaceReached::operator() ( propagator_state_t &  state,
const stepper_t &  stepper,
const navigator_t &  navigator,
const Surface targetSurface,
const Logger logger 
) const
inline

boolean operator for abort condition without using the result

Template Parameters
propagator_state_tType of the propagator state
stepper_tType of the stepper
navigator_tType of the navigator
Parameters
[in,out]stateThe propagation state object
[in]stepperStepper used for the propagation
[in]navigatorNavigator used for the propagation
[in]targetSurfaceThe target surface
loggera logger instance

Definition at line 127 of file StandardAborters.hpp.

View newest version in sPHENIX GitHub at line 127 of file StandardAborters.hpp

References Acts::ConstrainedStep::aborter, Acts::ACTS_VERBOSE(), Acts::detail::checkIntersection(), closest(), distance(), Acts::Surface::intersect(), logger(), overstepLimit, and Acts::Test::tolerance.

+ Here is the call graph for this function:

Member Data Documentation

std::optional<double> Acts::SurfaceReached::overstepLimit

Definition at line 91 of file StandardAborters.hpp.

View newest version in sPHENIX GitHub at line 91 of file StandardAborters.hpp

Referenced by operator()().


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