G4MagIntegratorStepper is an abstract base class for integrator of particle's equation of motion, used in tracking in space dependent magnetic field. More...

#include <G4MagIntegratorStepper.hh>

Inheritance diagram for G4MagIntegratorStepper:

Public Member Functions
	G4MagIntegratorStepper (G4EquationOfMotion *Equation, G4int numIntegrationVariables, G4int numStateVariables=12, G4bool isFSAL=false)
virtual	~G4MagIntegratorStepper ()=default
	G4MagIntegratorStepper (const G4MagIntegratorStepper &)=delete
G4MagIntegratorStepper &	operator= (const G4MagIntegratorStepper &)=delete
virtual void	Stepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[], G4double yerr[])=0
virtual G4double	DistChord () const =0
void	NormaliseTangentVector (G4double vec[6])
void	NormalisePolarizationVector (G4double vec[12])
void	RightHandSide (const G4double y[], G4double dydx[]) const
void	RightHandSide (const G4double y[], G4double dydx[], G4double field[]) const
G4int	GetNumberOfVariables () const
G4int	GetNumberOfStateVariables () const
virtual G4int	IntegratorOrder () const =0
virtual G4StepperType	StepperType () const
G4int	IntegrationOrder ()
G4EquationOfMotion *	GetEquationOfMotion ()
const G4EquationOfMotion *	GetEquationOfMotion () const
void	SetEquationOfMotion (G4EquationOfMotion *newEquation)
unsigned long	GetfNoRHSCalls ()
void	ResetfNORHSCalls ()
G4bool	IsFSAL () const
G4bool	isQSS () const
void	SetIsQSS (G4bool val)

Protected Member Functions
void	SetIntegrationOrder (G4int order)
void	SetFSAL (G4bool flag=true)

Detailed Description

G4MagIntegratorStepper is an abstract base class for integrator of particle's equation of motion, used in tracking in space dependent magnetic field.

Definition at line 58 of file G4MagIntegratorStepper.hh.

Constructor & Destructor Documentation

◆ G4MagIntegratorStepper() [1/2]

G4MagIntegratorStepper::G4MagIntegratorStepper	(	G4EquationOfMotion *	Equation,
		G4int	numIntegrationVariables,
		G4int	numStateVariables = 12,
		G4bool	isFSAL = false )

Constructor for G4MagIntegratorStepper.

Parameters

[in]	Equation	Pointer to the provided equation of motion.
[in]	numIntegrationVariables	The number of integration variables.
[in]	numStateVariables	The number of state variables.
[in]	isFSAL	Flag to indicate if it is an FSAL (First Same As Last) type driver.

Definition at line 36 of file G4MagIntegratorStepper.cc.

  : fEquation_Rhs(Equation),
    fNoIntegrationVariables(num_integration_vars),
    fNoStateVariables(std::max(num_state_vars,8)),
    fIsFSAL(isFSAL)
{
  if( Equation == nullptr )
  {
     G4Exception( "G4MagIntegratorStepper::G4MagIntegratorStepper", "GeomField0003",
                  FatalErrorInArgument, "Must have non-null equation." );
  }
}

Referenced by G4BogackiShampine23::G4BogackiShampine23(), G4BogackiShampine45::G4BogackiShampine45(), G4CashKarpRKF45::G4CashKarpRKF45(), G4DoLoMcPriRK34::G4DoLoMcPriRK34(), G4DormandPrince745::G4DormandPrince745(), G4DormandPrinceRK56::G4DormandPrinceRK56(), G4DormandPrinceRK78::G4DormandPrinceRK78(), G4MagHelicalStepper::G4MagHelicalStepper(), G4MagIntegratorStepper(), G4NystromRK4::G4NystromRK4(), G4QSStepper::G4QSStepper(), G4RK547FEq1::G4RK547FEq1(), G4RK547FEq2::G4RK547FEq2(), G4RK547FEq3::G4RK547FEq3(), G4RKG3_Stepper::G4RKG3_Stepper(), G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45(), G4TDormandPrince45< T_Equation, N >::G4TDormandPrince45(), G4TMagErrorStepper< T_Stepper, T_Equation, N >::G4TMagErrorStepper(), G4TsitourasRK45::G4TsitourasRK45(), operator=(), and G4HelixMixedStepper::SetupStepper().

◆ ~G4MagIntegratorStepper()

virtual G4MagIntegratorStepper::~G4MagIntegratorStepper ( )

virtualdefault

Default virtual Destructor.

◆ G4MagIntegratorStepper() [2/2]

G4MagIntegratorStepper::G4MagIntegratorStepper ( const G4MagIntegratorStepper & )

delete

Copy constructor and assignment operator not allowed.

Member Function Documentation

◆ DistChord()

virtual G4double G4MagIntegratorStepper::DistChord ( ) const

pure virtual

Estimates the maximum distance of a chord from the true path over the segment last integrated.

Implemented in G4BogackiShampine23, G4BogackiShampine45, G4CashKarpRKF45, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrince745, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4HelixExplicitEuler, G4HelixMixedStepper, G4MagErrorStepper, G4MagHelicalStepper, G4NystromRK4, G4QSStepper, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4RKG3_Stepper, G4TCashKarpRKF45< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TMagErrorStepper< T_Stepper, T_Equation, N >, G4TMagErrorStepper< G4TClassicalRK4< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleRunge< T_Equation, N >, T_Equation, N >, and G4TsitourasRK45.

◆ GetEquationOfMotion() [1/2]

G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( )

inline

Methods returning the pointer to the associated equation of motion. As some steppers (e.g. RKG3) require other methods of Eq_Rhs this function allows for access to them.

Referenced by G4DormandPrince745::GetSpecificEquation(), G4NystromRK4::SetDistanceForConstantField(), G4RKG3_Stepper::StepNoErr(), and G4RKG3_Stepper::Stepper().

◆ GetEquationOfMotion() [2/2]

const G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( ) const

inline

◆ GetfNoRHSCalls()

unsigned long G4MagIntegratorStepper::GetfNoRHSCalls ( )

inline

Methods for counting/resetting the number of calls to RHS method(s).

◆ GetNumberOfStateVariables()

G4int G4MagIntegratorStepper::GetNumberOfStateVariables ( ) const

inline

Returns the number of variables of state variables (>= above, integration).

Referenced by G4BogackiShampine45::G4BogackiShampine45(), G4CashKarpRKF45::G4CashKarpRKF45(), G4SimpleRunge::G4SimpleRunge(), G4TSimpleRunge< T_Equation, N >::G4TSimpleRunge(), G4TsitourasRK45::G4TsitourasRK45(), G4ConstRK4::Stepper(), G4MagErrorStepper::Stepper(), and G4TMagErrorStepper< T_Stepper, T_Equation, N >::Stepper().

◆ GetNumberOfVariables()

G4int G4MagIntegratorStepper::GetNumberOfVariables ( ) const

inline

Returns the number of variables that the stepper will integrate over.

Referenced by G4ClassicalRK4::DumbStepper(), G4ExplicitEuler::DumbStepper(), G4ImplicitEuler::DumbStepper(), G4ChordFinder::G4ChordFinder(), G4BogackiShampine45::GetLastDydx(), G4DoLoMcPriRK34::Interpolate(), G4TsitourasRK45::Interpolate(), G4DormandPrince745::Interpolate4thOrder(), G4DormandPrince745::Interpolate5thOrder(), G4DormandPrinceRK56::Interpolate_high(), G4DormandPrinceRK56::Interpolate_low(), G4BogackiShampine45::InterpolateHigh(), G4DormandPrinceRK56::SetupInterpolate_high(), G4DormandPrinceRK56::SetupInterpolate_low(), G4DormandPrince745::SetupInterpolation5thOrder(), G4BogackiShampine45::SetupInterpolationHigh(), G4BogackiShampine45::Stepper(), G4CashKarpRKF45::Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrince745::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), and G4TsitourasRK45::Stepper().

◆ IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inline

Replacement method - using new data member.

◆ IntegratorOrder()

virtual G4int G4MagIntegratorStepper::IntegratorOrder ( ) const

pure virtual

Returns the order of the integrator, i.e. its error behaviour is of the order O(h^order).

Implemented in G4BogackiShampine23, G4BogackiShampine45, G4CashKarpRKF45, G4ClassicalRK4, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrince745, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4ExplicitEuler, G4HelixExplicitEuler, G4HelixHeum, G4HelixImplicitEuler, G4HelixMixedStepper, G4HelixSimpleRunge, G4ImplicitEuler, G4NystromRK4, G4QSStepper, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4RKG3_Stepper, G4SimpleHeum, G4SimpleRunge, G4TCashKarpRKF45< T_Equation, N >, G4TClassicalRK4< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TExplicitEuler< T_Equation, N >, G4TSimpleHeum< T_Equation, N >, G4TSimpleRunge< T_Equation, N >, and G4TsitourasRK45.

Referenced by G4MagErrorStepper::Stepper().

◆ IsFSAL()

G4bool G4MagIntegratorStepper::IsFSAL ( ) const

inline

Returns true if the stepper is of FSAL (First Same As Last) type.

◆ isQSS()

G4bool G4MagIntegratorStepper::isQSS ( ) const

inline

Returns true if the stepper is of QSS (Quantum State Simulation) type.

Referenced by G4ChordFinder::G4ChordFinder().

◆ NormalisePolarizationVector()

void G4MagIntegratorStepper::NormalisePolarizationVector ( G4double vec[12] )

inline

Simple utility function to (re)normalise 'unit spin' vector.

Referenced by G4ClassicalRK4::DumbStepper(), G4SimpleHeum::DumbStepper(), G4TClassicalRK4< T_Equation, N >::DumbStepper(), and G4TSimpleHeum< T_Equation, N >::DumbStepper().

◆ NormaliseTangentVector()

void G4MagIntegratorStepper::NormaliseTangentVector ( G4double vec[6] )

inline

Simple utility function to (re)normalise 'unit velocity' vector.

◆ operator=()

G4MagIntegratorStepper & G4MagIntegratorStepper::operator= ( const G4MagIntegratorStepper & )

delete

◆ ResetfNORHSCalls()

void G4MagIntegratorStepper::ResetfNORHSCalls ( )

inline

◆ RightHandSide() [1/2]

void G4MagIntegratorStepper::RightHandSide	(	const G4double	y[],
		G4double	dydx[] ) const

inline

Utility method to supply the standard Evaluation of the Right Hand side of the associated equation.

Referenced by G4ClassicalRK4::DumbStepper(), G4ImplicitEuler::DumbStepper(), G4SimpleHeum::DumbStepper(), G4SimpleRunge::DumbStepper(), G4DormandPrinceRK56::SetupInterpolate_high(), G4DormandPrinceRK56::SetupInterpolate_low(), G4DormandPrince745::SetupInterpolation5thOrder(), G4BogackiShampine45::SetupInterpolationHigh(), G4BogackiShampine45::Stepper(), G4CashKarpRKF45::Stepper(), G4DoLoMcPriRK34::Stepper(), G4DormandPrince745::Stepper(), G4DormandPrinceRK56::Stepper(), G4DormandPrinceRK78::Stepper(), G4MagErrorStepper::Stepper(), and G4TsitourasRK45::Stepper().

◆ RightHandSide() [2/2]

void G4MagIntegratorStepper::RightHandSide	(	const G4double	y[],
		G4double	dydx[],
		G4double	field[] ) const

inline

Calculates 'dydx' and 'field' at point 'y'.

◆ SetEquationOfMotion()

void G4MagIntegratorStepper::SetEquationOfMotion ( G4EquationOfMotion * newEquation )

inline

Setter for the equation of motion.

◆ SetFSAL()

void G4MagIntegratorStepper::SetFSAL ( G4bool flag = true )

inlineprotected

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ SetIntegrationOrder()

void G4MagIntegratorStepper::SetIntegrationOrder ( G4int order )

inlineprotected

Setters for the integration order and FSAL type.

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ SetIsQSS()

void G4MagIntegratorStepper::SetIsQSS ( G4bool val )

inline

Referenced by G4QSStepper::G4QSStepper().

◆ Stepper()

virtual void G4MagIntegratorStepper::Stepper	(	const G4double	y[],
		const G4double	dydx[],
		G4double	h,
		G4double	yout[],
		G4double	yerr[] )

pure virtual

The stepper for the Runge Kutta integration. The stepsize is fixed, with the step size given by 'h'. Integrates ODE starting values y[0 to 6]. Outputs yout[] and its estimated error yerr[].

Parameters

[in]	y	Starting values array of integration variables.
[in]	dydx	Derivatives array.
[in]	h	The given step size.
[out]	yout	Integration output.
[out]	yerr	The estimated error.

Implemented in G4BogackiShampine23, G4BogackiShampine45, G4CashKarpRKF45, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrince745, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4HelixMixedStepper, G4MagErrorStepper, G4MagHelicalStepper, G4NystromRK4, G4QSStepper, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4RKG3_Stepper, G4TCashKarpRKF45< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TMagErrorStepper< T_Stepper, T_Equation, N >, G4TMagErrorStepper< G4TClassicalRK4< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleRunge< T_Equation, N >, T_Equation, N >, and G4TsitourasRK45.

◆ StepperType()

virtual G4StepperType G4MagIntegratorStepper::StepperType ( ) const

inlinevirtual

Returns the stepper type ID ('kUserStepper'). This function should be overriden in derived classes.

Reimplemented in G4BogackiShampine23, G4BogackiShampine45, G4CashKarpRKF45, G4ClassicalRK4, G4ConstRK4, G4DoLoMcPriRK34, G4DormandPrince745, G4DormandPrinceRK56, G4DormandPrinceRK78, G4ExactHelixStepper, G4ExplicitEuler, G4HelixExplicitEuler, G4HelixHeum, G4HelixImplicitEuler, G4HelixMixedStepper, G4HelixSimpleRunge, G4ImplicitEuler, G4NystromRK4, G4QSStepper, G4RK547FEq1, G4RK547FEq2, G4RK547FEq3, G4RKG3_Stepper, G4SimpleHeum, G4SimpleRunge, G4TCashKarpRKF45< T_Equation, N >, G4TDormandPrince45< T_Equation, N >, G4TMagErrorStepper< T_Stepper, T_Equation, N >, G4TMagErrorStepper< G4TClassicalRK4< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TExplicitEuler< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleHeum< T_Equation, N >, T_Equation, N >, G4TMagErrorStepper< G4TSimpleRunge< T_Equation, N >, T_Equation, N >, and G4TsitourasRK45.

Definition at line 152 of file G4MagIntegratorStepper.hh.

152{ return kUserStepper; }

kUserStepper

@ kUserStepper

User defined stepper.

Definition G4FieldParameters.hh:124

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ G4MagIntegratorStepper() [1/2]

◆ ~G4MagIntegratorStepper()

◆ G4MagIntegratorStepper() [2/2]

Member Function Documentation

◆ DistChord()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ isQSS()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ operator=()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ SetIsQSS()

◆ Stepper()

◆ StepperType()