#include <G4RKG3_Stepper.hh>

Inheritance diagram for G4RKG3_Stepper:

Public Member Functions
G4double	DistChord () const

	G4RKG3_Stepper (G4Mag_EqRhs *EqRhs)

G4EquationOfMotion *	GetEquationOfMotion ()

const G4EquationOfMotion *	GetEquationOfMotion () const

unsigned long	GetfNoRHSCalls ()

G4int	GetNumberOfStateVariables () const

G4int	GetNumberOfVariables () const

G4int	IntegrationOrder ()

G4int	IntegratorOrder () const

G4bool	IsFSAL () const

void	NormalisePolarizationVector (G4double vec[12])

void	NormaliseTangentVector (G4double vec[6])

void	ResetfNORHSCalls ()

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

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

void	SetEquationOfMotion (G4EquationOfMotion *newEquation)

void	StepNoErr (const G4double tIn[8], const G4double dydx[6], G4double Step, G4double tOut[8], G4double B[3])

void	Stepper (const G4double yIn[], const G4double dydx[], G4double h, G4double yOut[], G4double yErr[])

void	StepWithEst (const G4double tIn[8], const G4double dydx[6], G4double Step, G4double tOut[8], G4double &alpha2, G4double &beta2, const G4double B1[3], G4double B2[3])

	~G4RKG3_Stepper ()

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Attributes
G4ThreeVector	BfldIn

G4EquationOfMotion *	fEquation_Rhs = nullptr

G4int	fIntegrationOrder = -1

G4bool	fIsFSAL = false

const G4int	fNoIntegrationVariables = 0

unsigned long	fNoRHSCalls = 0UL

const G4int	fNoStateVariables = 0

G4ThreeVector	fpInitial

G4ThreeVector	fyFinal

G4ThreeVector	fyInitial

G4ThreeVector	fyMidPoint

G4double	hStep = 0.0

Detailed Description

Definition at line 43 of file G4RKG3_Stepper.hh.

Constructor & Destructor Documentation

◆ G4RKG3_Stepper()

G4RKG3_Stepper::G4RKG3_Stepper ( G4Mag_EqRhs * EqRhs )

Definition at line 35 of file G4RKG3_Stepper.cc.

  : G4MagIntegratorStepper(EqRhs,6)
{
}

◆ ~G4RKG3_Stepper()

G4RKG3_Stepper::~G4RKG3_Stepper ( )

Definition at line 40 of file G4RKG3_Stepper.cc.

41{

42}

Member Function Documentation

◆ DistChord()

G4double G4RKG3_Stepper::DistChord ( ) const

virtual

Implements G4MagIntegratorStepper.

Definition at line 196 of file G4RKG3_Stepper.cc.

{
   // Soon: must check whether h/R > 2 pi  !!
   // Method below is good only for < 2 pi
 
   G4double distChord,distLine;
   
   if (fyInitial != fyFinal)
   {
      distLine = G4LineSection::Distline(fyMidPoint,fyInitial,fyFinal);
      distChord = distLine;
   }
   else
   {
      distChord = (fyMidPoint-fyInitial).mag();
   }
 
   return distChord;
}

References G4LineSection::Distline(), fyFinal, fyInitial, and fyMidPoint.

◆ GetEquationOfMotion() [1/2]

G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( )

inlineinherited

Referenced by G4MagInt_Driver::GetEquationOfMotion(), G4OldMagIntDriver::GetEquationOfMotion(), G4NystromRK4::GetField(), G4DormandPrince745::GetSpecificEquation(), G4NystromRK4::SetDistanceForConstantField(), StepNoErr(), and Stepper().

◆ GetEquationOfMotion() [2/2]

const G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( ) const

inlineinherited

◆ GetfNoRHSCalls()

unsigned long G4MagIntegratorStepper::GetfNoRHSCalls ( )

inlineinherited

◆ GetNumberOfStateVariables()

G4int G4MagIntegratorStepper::GetNumberOfStateVariables ( ) const

inlineinherited

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

◆ GetNumberOfVariables()

G4int G4MagIntegratorStepper::GetNumberOfVariables ( ) const

inlineinherited

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

◆ IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inlineinherited

◆ IntegratorOrder()

G4int G4RKG3_Stepper::IntegratorOrder ( ) const

inlinevirtual

Implements G4MagIntegratorStepper.

Definition at line 88 of file G4RKG3_Stepper.hh.

88{ return 4; }

◆ IsFSAL()

G4bool G4MagIntegratorStepper::IsFSAL ( ) const

inlineinherited

◆ NormalisePolarizationVector()

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

inlineinherited

Referenced by G4SimpleHeum::DumbStepper(), and G4ClassicalRK4::DumbStepper().

◆ NormaliseTangentVector()

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

inlineinherited

◆ ResetfNORHSCalls()

void G4MagIntegratorStepper::ResetfNORHSCalls ( )

inlineinherited

◆ RightHandSide() [1/2]

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

inlineinherited

◆ RightHandSide() [2/2]

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

inlineinherited

◆ SetEquationOfMotion()

void G4MagIntegratorStepper::SetEquationOfMotion ( G4EquationOfMotion * newEquation )

inlineinherited

Referenced by G4MagInt_Driver::SetEquationOfMotion(), and G4OldMagIntDriver::SetEquationOfMotion().

◆ SetFSAL()

void G4MagIntegratorStepper::SetFSAL ( G4bool flag = true )

inlineprotectedinherited

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ SetIntegrationOrder()

void G4MagIntegratorStepper::SetIntegrationOrder ( G4int order )

inlineprotectedinherited

Referenced by G4BogackiShampine23::G4BogackiShampine23().

◆ StepNoErr()

void G4RKG3_Stepper::StepNoErr	(	const G4double	tIn[8],
		const G4double	dydx[6],
		G4double	Step,
		G4double	tOut[8],
		G4double	B[3]
	)

Definition at line 130 of file G4RKG3_Stepper.cc.

{ 
  
   // Copy and edit the routine above, to delete alpha2, beta2, ...
   //
   G4double K1[7], K2[7], K3[7], K4[7];
   G4double tTemp[8]={0.0}, yderiv[6]={0.0};
 
   // Need Momentum value to give correct values to the coefficients in
   // equation. Integration on unit velocity, but tIn[3,4,5] is momentum
 
   G4double mom, inverse_mom;
   const G4double c1=0.5, c2=0.125, c3=1./6.;
  
   // Correction for momentum not a velocity
   // Need the protection !!! must be not zero
   //
   mom = std::sqrt(tIn[3]*tIn[3]+tIn[4]*tIn[4]+tIn[5]*tIn[5]); 
   inverse_mom = 1./mom;    
   for(auto i=0; i<3; ++i)
   {
      K1[i] = Step * dydx[i+3]*inverse_mom;
      tTemp[i] = tIn[i] + Step*(c1*tIn[i+3]*inverse_mom + c2*K1[i]) ;
      tTemp[i+3] = tIn[i+3] + c1*K1[i]*mom ;
   }
    
   GetEquationOfMotion()->EvaluateRhsReturnB(tTemp,yderiv,B) ;
      
   for(auto i=0; i<3; ++i)
   {
      K2[i] = Step * yderiv[i+3]*inverse_mom;
      tTemp[i+3] = tIn[i+3] + c1*K2[i]*mom ;
   }
   
   // Given B, calculate yderiv !
   //
   GetEquationOfMotion()->EvaluateRhsGivenB(tTemp,B,yderiv) ;  
 
   for(auto i=0; i<3; ++i)
   {
      K3[i] = Step * yderiv[i+3]*inverse_mom;
      tTemp[i] = tIn[i] + Step*(tIn[i+3]*inverse_mom + c1*K3[i]) ;
      tTemp[i+3] = tIn[i+3] + K3[i]*mom ;
   }
 
   // Calculates y-deriv(atives) & returns B too!
   //
   GetEquationOfMotion()->EvaluateRhsReturnB(tTemp,yderiv,B) ;  
 
   for(auto i=0; i<3; ++i)        // Output trajectory vector
   {
      K4[i] = Step * yderiv[i+3]*inverse_mom;
      tOut[i] = tIn[i] + Step*(tIn[i+3]*inverse_mom+ (K1[i]+K2[i]+K3[i])*c3) ;
      tOut[i+3] = tIn[i+3] + mom*(K1[i] + 2*K2[i] + 2*K3[i] +K4[i])*c3 ;
   }
   tOut[6] = tIn[6];
   tOut[7] = tIn[7];
}

References B(), G4EquationOfMotion::EvaluateRhsGivenB(), G4EquationOfMotion::EvaluateRhsReturnB(), and G4MagIntegratorStepper::GetEquationOfMotion().

Referenced by Stepper().

◆ Stepper()

void G4RKG3_Stepper::Stepper	(	const G4double	yIn[],
		const G4double	dydx[],
		G4double	h,
		G4double	yOut[],
		G4double	yErr[]
	)

virtual

Implements G4MagIntegratorStepper.

Definition at line 44 of file G4RKG3_Stepper.cc.

{
   G4double  B[3];
   G4int nvar = 6 ;
   G4double  by15 = 1. / 15. ; // was  0.066666666 ;
 
   G4double yTemp[8], dydxTemp[6], yIn[8];
 
   // Saving yInput because yInput and yOut can be aliases for same array
   //
   for(G4int i=0; i<nvar; ++i)
   {
     yIn[i]=yInput[i];
   }
   yIn[6] = yInput[6];
   yIn[7] = yInput[7];
   G4double h = Step * 0.5; 
   hStep = Step;
     // Do two half steps
 
   StepNoErr(yIn, dydx,h, yTemp,B) ;
   
   // Store Bfld for DistChord Calculation
   //
   for(auto i=0; i<3; ++i)
   {
     BfldIn[i] = B[i];
   }
   // RightHandSide(yTemp,dydxTemp) ;
 
   GetEquationOfMotion()->EvaluateRhsGivenB(yTemp,B,dydxTemp) ;  
   StepNoErr(yTemp,dydxTemp,h,yOut,B);      
        
   // Store midpoint, chord calculation
                                 
   fyMidPoint = G4ThreeVector(yTemp[0],  yTemp[1],  yTemp[2]); 
 
   // Do a full Step
  //
   h *= 2 ;
   StepNoErr(yIn,dydx,h,yTemp,B); 
   for(G4int i=0; i<nvar; ++i)
   {
      yErr[i] = yOut[i] - yTemp[i] ;
      yOut[i] += yErr[i]*by15 ;          // Provides 5th order of accuracy
   }
 
   // Store values for DistChord method
   //
   fyInitial = G4ThreeVector( yIn[0],   yIn[1],   yIn[2]);
   fpInitial = G4ThreeVector( yIn[3],   yIn[4],   yIn[5]);
   fyFinal   = G4ThreeVector( yOut[0],  yOut[1],  yOut[2]); 
}

References B(), BfldIn, G4EquationOfMotion::EvaluateRhsGivenB(), fpInitial, fyFinal, fyInitial, fyMidPoint, G4MagIntegratorStepper::GetEquationOfMotion(), hStep, and StepNoErr().

◆ StepWithEst()

void G4RKG3_Stepper::StepWithEst	(	const G4double	tIn[8],
		const G4double	dydx[6],
		G4double	Step,
		G4double	tOut[8],
		G4double &	alpha2,
		G4double &	beta2,
		const G4double	B1[3],
		G4double	B2[3]
	)

Definition at line 109 of file G4RKG3_Stepper.cc.

{
  G4Exception("G4RKG3_Stepper::StepWithEst()", "GeomField0001",
              FatalException, "Method no longer used.");
}

References FatalException, and G4Exception().

Field Documentation

◆ BfldIn

G4ThreeVector G4RKG3_Stepper::BfldIn

private

Definition at line 96 of file G4RKG3_Stepper.hh.

Referenced by Stepper().

◆ fEquation_Rhs

G4EquationOfMotion* G4MagIntegratorStepper::fEquation_Rhs = nullptr

privateinherited

Definition at line 124 of file G4MagIntegratorStepper.hh.

◆ fIntegrationOrder

G4int G4MagIntegratorStepper::fIntegrationOrder = -1

privateinherited

Definition at line 134 of file G4MagIntegratorStepper.hh.

◆ fIsFSAL

G4bool G4MagIntegratorStepper::fIsFSAL = false

privateinherited

Definition at line 136 of file G4MagIntegratorStepper.hh.

◆ fNoIntegrationVariables

const G4int G4MagIntegratorStepper::fNoIntegrationVariables = 0

privateinherited

Definition at line 125 of file G4MagIntegratorStepper.hh.

◆ fNoRHSCalls

unsigned long G4MagIntegratorStepper::fNoRHSCalls = 0UL

mutableprivateinherited

Definition at line 128 of file G4MagIntegratorStepper.hh.

◆ fNoStateVariables

const G4int G4MagIntegratorStepper::fNoStateVariables = 0

privateinherited

Definition at line 126 of file G4MagIntegratorStepper.hh.

◆ fpInitial

G4ThreeVector G4RKG3_Stepper::fpInitial

private

Definition at line 95 of file G4RKG3_Stepper.hh.

Referenced by Stepper().

◆ fyFinal

G4ThreeVector G4RKG3_Stepper::fyFinal

private

Definition at line 94 of file G4RKG3_Stepper.hh.

Referenced by DistChord(), and Stepper().

◆ fyInitial

G4ThreeVector G4RKG3_Stepper::fyInitial

private

Definition at line 92 of file G4RKG3_Stepper.hh.

Referenced by DistChord(), and Stepper().

◆ fyMidPoint

G4ThreeVector G4RKG3_Stepper::fyMidPoint

private

Definition at line 93 of file G4RKG3_Stepper.hh.

Referenced by DistChord(), and Stepper().

◆ hStep

G4double G4RKG3_Stepper::hStep = 0.0

private

Definition at line 97 of file G4RKG3_Stepper.hh.

Referenced by Stepper().

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

source/geometry/magneticfield/include/G4RKG3_Stepper.hh
source/geometry/magneticfield/src/G4RKG3_Stepper.cc

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4RKG3_Stepper()

◆ ~G4RKG3_Stepper()

Member Function Documentation

◆ DistChord()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ StepNoErr()

◆ Stepper()

◆ StepWithEst()

Field Documentation

◆ BfldIn

◆ fEquation_Rhs

◆ fIntegrationOrder

◆ fIsFSAL

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ fpInitial

◆ fyFinal

◆ fyInitial

◆ fyMidPoint

◆ hStep