Evaluater of the k_i's and elements of the transport matrix D of the RKN4 stepping. This implementation involves energy loss due to ioninisation, bremsstrahlung, pair production and photonuclear interaction in the propagation and the jacobian. These effects will only occur if the propagation is in a TrackingVolume with attached material. More...

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

Collaboration diagram for Acts::DenseEnvironmentExtension:

Public Member Functions
	DenseEnvironmentExtension ()=default
	Default constructor.

template<typename propagator_state_t , typename stepper_t >
int	bid (const propagator_state_t &state, const stepper_t &stepper) const
	Control function if the step evaluation would be valid.

template<typename propagator_state_t , typename stepper_t >
bool	k (const propagator_state_t &state, const stepper_t &stepper, Vector3D &knew, const Vector3D &bField, std::array< double, 4 > &kQoP, const int i=0, const double h=0., const Vector3D &kprev=Vector3D())
	Evaluater of the k_i's of the RKN4. For the case of i = 0 this step sets up member parameters, too.

template<typename propagator_state_t , typename stepper_t >
bool	finalize (propagator_state_t &state, const stepper_t &stepper, const double h) const
	After a RKN4 step was accepted by the stepper this method has an additional veto on the quality of the step. The veto lies in evaluation of the energy loss and the therewith constrained to keep the momentum after the step in reasonable values.

template<typename propagator_state_t , typename stepper_t >
bool	finalize (propagator_state_t &state, const stepper_t &stepper, const double h, FreeMatrix &D) const
	After a RKN4 step was accepted by the stepper this method has an additional veto on the quality of the step. The veto lies in the evaluation of the energy loss, the therewith constrained to keep the momentum after the step in reasonable values and the evaluation of the transport matrix.

Public Attributes
double	currentMomentum = 0.
	Momentum at a certain point.

double	initialMomentum = 0.
	Particles momentum at k1.

Material	material

std::array< double, 4 >	dLdl
	Derivatives dLambda''dlambda at each sub-step point.

std::array< double, 4 >	qop
	q/p at each sub-step

std::array< double, 4 >	dPds
	Derivatives dPds at each sub-step.

double	dgdqopValue = 0.
	Derivative d(dEds)d(q/p) evaluated at the initial point.

double	g = 0.
	Derivative dEds at the initial point.

std::array< double, 4 >	tKi
	k_i equivalent for the time propagation

std::array< double, 4 >	Lambdappi
	Lambda''_i.

std::array< double, 4 >	energy
	Energy at each sub-step.

Private Member Functions
template<typename propagator_state_t , typename stepper_t >
bool	transportMatrix (propagator_state_t &state, const stepper_t &stepper, const double h, FreeMatrix &D) const
	Evaluates the transport matrix D for the jacobian.

template<typename propagator_state_t >
void	initializeEnergyLoss (const propagator_state_t &state)
	Initializer of all parameters related to a RKN4 step with energy loss of a particle in material.

template<typename stepper_state_t , typename stepper_t >
void	updateEnergyLoss (const double mass, const double h, const stepper_state_t &state, const stepper_t &stepper, const int i)
	Update of the kinematic parameters of the RKN4 sub-steps after initialization with energy loss of a particle in material.

Detailed Description

Evaluater of the k_i's and elements of the transport matrix D of the RKN4 stepping. This implementation involves energy loss due to ioninisation, bremsstrahlung, pair production and photonuclear interaction in the propagation and the jacobian. These effects will only occur if the propagation is in a TrackingVolume with attached material.

Definition at line 26 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 26 of file DenseEnvironmentExtension.hpp

Constructor & Destructor Documentation

Acts::DenseEnvironmentExtension::DenseEnvironmentExtension ( )

default

Default constructor.

Member Function Documentation

template<typename propagator_state_t , typename stepper_t >

int Acts::DenseEnvironmentExtension::bid	(	const propagator_state_t &	state,
		const stepper_t &	stepper
	)		const

inline

Control function if the step evaluation would be valid.

Template Parameters

propagator_state_t	Type of the state of the propagator
stepper_t	Type of the stepper

Parameters

[in] state State of the propagator

Returns: Boolean flag if the step would be valid

Definition at line 61 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 61 of file DenseEnvironmentExtension.hpp

template<typename propagator_state_t , typename stepper_t >

bool Acts::DenseEnvironmentExtension::finalize	(	propagator_state_t &	state,
		const stepper_t &	stepper,
		const double	h
	)		const

inline

After a RKN4 step was accepted by the stepper this method has an additional veto on the quality of the step. The veto lies in evaluation of the energy loss and the therewith constrained to keep the momentum after the step in reasonable values.

Template Parameters

propagator_state_t	Type of the state of the propagator
stepper_t	Type of the stepper

Parameters

[in]	state	State of the propagator
[in]	h	Step size

Returns: Boolean flag if the calculation is valid

Definition at line 145 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 145 of file DenseEnvironmentExtension.hpp

References dPds, g, and tKi.

Referenced by finalize().

Here is the caller graph for this function:

template<typename propagator_state_t , typename stepper_t >

bool Acts::DenseEnvironmentExtension::finalize	(	propagator_state_t &	state,
		const stepper_t &	stepper,
		const double	h,
		FreeMatrix &	D
	)		const

inline

After a RKN4 step was accepted by the stepper this method has an additional veto on the quality of the step. The veto lies in the evaluation of the energy loss, the therewith constrained to keep the momentum after the step in reasonable values and the evaluation of the transport matrix.

Template Parameters

propagator_state_t	Type of the state of the propagator
stepper_t	Type of the stepper

Parameters

[in]	state	State of the propagator
[in]	h	Step size
[out]	D	Transport matrix

Returns: Boolean flag if the calculation is valid

Definition at line 188 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 188 of file DenseEnvironmentExtension.hpp

References finalize(), and transportMatrix().

Here is the call graph for this function:

template<typename propagator_state_t >

void Acts::DenseEnvironmentExtension::initializeEnergyLoss ( const propagator_state_t & state )

inlineprivate

Initializer of all parameters related to a RKN4 step with energy loss of a particle in material.

Template Parameters

propagator_state_t Type of the state of the propagator

Parameters

[in] state Deliverer of configurations

Definition at line 349 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 349 of file DenseEnvironmentExtension.hpp

References Acts::computeEnergyLossMean(), Acts::computeEnergyLossMode(), Acts::deriveEnergyLossMeanQOverP(), Acts::deriveEnergyLossModeQOverP(), dgdqopValue, dLdl, dPds, energy, g, initialMomentum, material, and qop.

Referenced by k().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename propagator_state_t , typename stepper_t >

bool Acts::DenseEnvironmentExtension::k	(	const propagator_state_t &	state,
		const stepper_t &	stepper,
		Vector3D &	knew,
		const Vector3D &	bField,
		std::array< double, 4 > &	kQoP,
		const int	i = `0`,
		const double	h = `0.`,
		const Vector3D &	kprev = `Vector3D()`
	)

inline

Evaluater of the k_i's of the RKN4. For the case of i = 0 this step sets up member parameters, too.

Template Parameters

stepper_state_t	Type of the state of the propagator
stepper_t	Type of the stepper

Parameters

[in]	state	State of the propagator
[out]	knew	Next k_i that is evaluated
[out]	kQoP	k_i elements of the momenta
[in]	bField	B-Field at the evaluation position
[in]	i	Index of the k_i, i = [0, 3]
[in]	h	Step size (= 0. ^ 0.5 * StepSize ^ StepSize)
[in]	kprev	Evaluated k_{i - 1}

Returns: Boolean flag if the calculation is valid

Definition at line 90 of file DenseEnvironmentExtension.hpp.

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

References Acts::UnitConstants::C, Acts::VectorHelpers::cross(), currentMomentum, energy, g, Acts::UnitConstants::h, initializeEnergyLoss(), initialMomentum, Lambdappi, material, qop, tKi, and updateEnergyLoss().

Here is the call graph for this function:

template<typename propagator_state_t , typename stepper_t >

bool Acts::DenseEnvironmentExtension::transportMatrix	(	propagator_state_t &	state,
		const stepper_t &	stepper,
		const double	h,
		FreeMatrix &	D
	)		const

inlineprivate

Evaluates the transport matrix D for the jacobian.

Template Parameters

propagator_state_t	Type of the state of the propagator
stepper_t	Type of the stepper

Parameters

[in]	state	State of the propagator
[in]	h	Step size
[out]	D	Transport matrix

Returns: Boolean flag if evaluation is valid

The calculations are based on ATL-SOFT-PUB-2009-002. The update of the Jacobian matrix is requires only the calculation of eq. 17 and 18. Since the terms of eq. 18 are currently 0, this matrix is not needed in the calculation. The matrix A from eq. 17 consists out of 3 different parts. The first one is given by the upper left 3x3 matrix that are calculated by dFdT and dGdT. The second is given by the top 3 lines of the rightmost column. This is calculated by dFdL and dGdL. The remaining non-zero term is calculated directly. The naming of the variables is explained in eq. 11 and are directly related to the initial problem in eq. 7. The evaluation is based on propagating the parameters T and lambda (including g(lambda) and E(lambda)) as given in eq. 16 and evaluating the derivations for matrix A.

Note: The translation for u_{n+1} in eq. 7 is in this case a 3-dimensional vector without a dependency of Lambda or lambda neither in u_n nor in u_n'. The second and fourth eq. in eq. 14 have the constant offset matrices h * Id and Id respectively. This involves that the constant offset does not exist for rectangular matrix dFdu' (due to the missing Lambda part) and only exists for dGdu' in dlambda/dlambda.

Propagation of derivatives of dLambda''dlambda at each sub-step

Definition at line 203 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 203 of file DenseEnvironmentExtension.hpp

References Acts::VectorHelpers::cross(), D(), dir, dLdl, Acts::UnitConstants::h, Lambdappi, and qop.

Referenced by finalize().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename stepper_state_t , typename stepper_t >

void Acts::DenseEnvironmentExtension::updateEnergyLoss	(	const double	mass,
		const double	h,
		const stepper_state_t &	state,
		const stepper_t &	stepper,
		const int	i
	)

inlineprivate

Update of the kinematic parameters of the RKN4 sub-steps after initialization with energy loss of a particle in material.

Template Parameters

stepper_state_t	Type of the state of the stepper
stepper_t	Type of the stepper

Parameters

[in]	h	Stepped distance of the sub-step (1-3)
[in]	state	State of the stepper
[in]	i	Index of the sub-step (1-3)

Definition at line 396 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 396 of file DenseEnvironmentExtension.hpp

References currentMomentum, dgdqopValue, dLdl, dPds, energy, g, initialMomentum, and qop.

Referenced by k().

Here is the caller graph for this function:

Member Data Documentation

double Acts::DenseEnvironmentExtension::currentMomentum = 0.

Momentum at a certain point.

Definition at line 28 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 28 of file DenseEnvironmentExtension.hpp

Referenced by k(), and updateEnergyLoss().

double Acts::DenseEnvironmentExtension::dgdqopValue = 0.

Derivative d(dEds)d(q/p) evaluated at the initial point.

Definition at line 41 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 41 of file DenseEnvironmentExtension.hpp

Referenced by initializeEnergyLoss(), and updateEnergyLoss().

std::array<double, 4> Acts::DenseEnvironmentExtension::dLdl

Derivatives dLambda''dlambda at each sub-step point.

Definition at line 35 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 35 of file DenseEnvironmentExtension.hpp

Referenced by initializeEnergyLoss(), transportMatrix(), and updateEnergyLoss().

std::array<double, 4> Acts::DenseEnvironmentExtension::dPds

Derivatives dPds at each sub-step.

Definition at line 39 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 39 of file DenseEnvironmentExtension.hpp

Referenced by finalize(), initializeEnergyLoss(), and updateEnergyLoss().

std::array<double, 4> Acts::DenseEnvironmentExtension::energy

Energy at each sub-step.

Definition at line 49 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 49 of file DenseEnvironmentExtension.hpp

Referenced by initializeEnergyLoss(), k(), and updateEnergyLoss().

double Acts::DenseEnvironmentExtension::g = 0.

Derivative dEds at the initial point.

Definition at line 43 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 43 of file DenseEnvironmentExtension.hpp

Referenced by finalize(), initializeEnergyLoss(), k(), and updateEnergyLoss().

double Acts::DenseEnvironmentExtension::initialMomentum = 0.

Particles momentum at k1.

Definition at line 30 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 30 of file DenseEnvironmentExtension.hpp

Referenced by initializeEnergyLoss(), k(), and updateEnergyLoss().

std::array<double, 4> Acts::DenseEnvironmentExtension::Lambdappi

Lambda''_i.

Definition at line 47 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 47 of file DenseEnvironmentExtension.hpp

Referenced by k(), and transportMatrix().

Material Acts::DenseEnvironmentExtension::material

Material that will be passed TODO : Might not be needed anymore

Definition at line 33 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 33 of file DenseEnvironmentExtension.hpp

Referenced by emcalc_gui.MainWindow::cb_select_material(), emcalc_gui.MainWindow::cb_show_plot(), initializeEnergyLoss(), and k().

std::array<double, 4> Acts::DenseEnvironmentExtension::qop

q/p at each sub-step

Definition at line 37 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 37 of file DenseEnvironmentExtension.hpp

Referenced by initializeEnergyLoss(), k(), transportMatrix(), and updateEnergyLoss().

std::array<double, 4> Acts::DenseEnvironmentExtension::tKi

k_i equivalent for the time propagation

Definition at line 45 of file DenseEnvironmentExtension.hpp.

View newest version in sPHENIX GitHub at line 45 of file DenseEnvironmentExtension.hpp

Referenced by finalize(), and k().

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

acts/blob/master/Core/include/Acts/Propagator/DenseEnvironmentExtension.hpp

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation