#include <G4ConstRK4.hh>

Inheritance diagram for G4ConstRK4:

Public Member Functions
G4double	DistChord () const

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

	G4ConstRK4 (const G4ConstRK4 &)=delete

	G4ConstRK4 (G4Mag_EqRhs *EquationMotion, G4int numberOfStateVariables=8)

void	GetConstField (const G4double y[], G4double Field[])

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])

G4ConstRK4 &	operator= (const G4ConstRK4 &)=delete

void	ResetfNORHSCalls ()

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

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

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

void	SetEquationOfMotion (G4EquationOfMotion *newEquation)

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

	~G4ConstRK4 ()

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Attributes
G4double *	dydxm

G4double *	dydxMid

G4double *	dydxt

G4Mag_EqRhs *	fEq = nullptr

G4EquationOfMotion *	fEquation_Rhs = nullptr

G4ThreeVector	fFinalPoint

G4double	Field [3]

G4ThreeVector	fInitialPoint

G4int	fIntegrationOrder = -1

G4bool	fIsFSAL = false

G4ThreeVector	fMidPoint

const G4int	fNoIntegrationVariables = 0

unsigned long	fNoRHSCalls = 0UL

const G4int	fNoStateVariables = 0

G4double *	yInitial

G4double *	yMiddle

G4double *	yOneStep

G4double *	yt

Detailed Description

Definition at line 45 of file G4ConstRK4.hh.

Constructor & Destructor Documentation

◆ G4ConstRK4() [1/2]

G4ConstRK4::G4ConstRK4	(	G4Mag_EqRhs *	EquationMotion,
		G4int	numberOfStateVariables = `8`
	)

Definition at line 40 of file G4ConstRK4.cc.

  : G4MagErrorStepper(EqRhs, 6, numStateVariables)
{
  // const G4int numberOfVariables= 6;
  if( numStateVariables < 8 ) 
  {
    std::ostringstream message;
    message << "The number of State variables at least 8 " << G4endl
            << "Instead it is - numStateVariables= " << numStateVariables;
    G4Exception("G4ConstRK4::G4ConstRK4()", "GeomField0002",
                FatalException, message, "Use another Stepper!");
  }
 
  fEq = EqRhs;
  yMiddle  = new G4double[8];
  dydxMid  = new G4double[8];
  yInitial = new G4double[8];
  yOneStep = new G4double[8];
 
  dydxm = new G4double[8];
  dydxt = new G4double[8]; 
  yt    = new G4double[8]; 
  Field[0]=0.; Field[1]=0.; Field[2]=0.;
}

References dydxm, dydxMid, dydxt, FatalException, fEq, Field, G4endl, G4Exception(), yInitial, yMiddle, yOneStep, and yt.

◆ ~G4ConstRK4()

G4ConstRK4::~G4ConstRK4 ( )

Definition at line 69 of file G4ConstRK4.cc.

{
   delete [] yMiddle;
   delete [] dydxMid;
   delete [] yInitial;
   delete [] yOneStep;
   delete [] dydxm;
   delete [] dydxt;
   delete [] yt;
}

References dydxm, dydxMid, dydxt, yInitial, yMiddle, yOneStep, and yt.

◆ G4ConstRK4() [2/2]

G4ConstRK4::G4ConstRK4 ( const G4ConstRK4 & )

delete

Member Function Documentation

◆ DistChord()

G4double G4ConstRK4::DistChord ( ) const

virtual

Implements G4MagIntegratorStepper.

Definition at line 211 of file G4ConstRK4.cc.

{
  G4double distLine, distChord; 
 
  if (fInitialPoint != fFinalPoint)
  {
     distLine= G4LineSection::Distline( fMidPoint, fInitialPoint, fFinalPoint );
       // This is a class method that gives distance of Mid 
       // from the Chord between the Initial and Final points
     distChord = distLine;
  }
  else
  {
     distChord = (fMidPoint-fInitialPoint).mag();
  }
  return distChord;
}

References G4LineSection::Distline(), fFinalPoint, fInitialPoint, and fMidPoint.

◆ DumbStepper()

void G4ConstRK4::DumbStepper	(	const G4double	yIn[],
		const G4double	dydx[],
		G4double	h,
		G4double	yOut[]
	)

virtual

Implements G4MagErrorStepper.

Definition at line 90 of file G4ConstRK4.cc.

{
   G4double  hh = h*0.5 , h6 = h/6.0  ;
   
   // 1st Step K1=h*dydx
   yt[5] = yIn[5] + hh*dydx[5] ;
   yt[4] = yIn[4] + hh*dydx[4] ;
   yt[3] = yIn[3] + hh*dydx[3] ;
   yt[2] = yIn[2] + hh*dydx[2] ;
   yt[1] = yIn[1] + hh*dydx[1] ;
   yt[0] = yIn[0] + hh*dydx[0] ;
   RightHandSideConst(yt,dydxt) ;        
 
   // 2nd Step K2=h*dydxt
   yt[5] = yIn[5] + hh*dydxt[5] ;
   yt[4] = yIn[4] + hh*dydxt[4] ;
   yt[3] = yIn[3] + hh*dydxt[3] ;
   yt[2] = yIn[2] + hh*dydxt[2] ;
   yt[1] = yIn[1] + hh*dydxt[1] ;
   yt[0] = yIn[0] + hh*dydxt[0] ;
   RightHandSideConst(yt,dydxm) ;     
 
   // 3rd Step K3=h*dydxm
   // now dydxm=(K2+K3)/h
   yt[5] = yIn[5] + h*dydxm[5] ;
   dydxm[5] += dydxt[5] ;  
   yt[4] = yIn[4] + h*dydxm[4] ;
   dydxm[4] += dydxt[4] ;  
   yt[3] = yIn[3] + h*dydxm[3] ;
   dydxm[3] += dydxt[3] ;  
   yt[2] = yIn[2] + h*dydxm[2] ;
   dydxm[2] += dydxt[2] ;  
   yt[1] = yIn[1] + h*dydxm[1] ;
   dydxm[1] += dydxt[1] ;  
   yt[0] = yIn[0] + h*dydxm[0] ;
   dydxm[0] += dydxt[0] ;  
   RightHandSideConst(yt,dydxt) ;   
 
   // 4th Step K4=h*dydxt
   yOut[5] = yIn[5]+h6*(dydx[5]+dydxt[5]+2.0*dydxm[5]);
   yOut[4] = yIn[4]+h6*(dydx[4]+dydxt[4]+2.0*dydxm[4]);
   yOut[3] = yIn[3]+h6*(dydx[3]+dydxt[3]+2.0*dydxm[3]);
   yOut[2] = yIn[2]+h6*(dydx[2]+dydxt[2]+2.0*dydxm[2]);
   yOut[1] = yIn[1]+h6*(dydx[1]+dydxt[1]+2.0*dydxm[1]);
   yOut[0] = yIn[0]+h6*(dydx[0]+dydxt[0]+2.0*dydxm[0]);
   
}  // end of DumbStepper ....................................................

References dydxm, dydxt, RightHandSideConst(), and yt.

Referenced by Stepper().

◆ GetConstField()

void G4ConstRK4::GetConstField	(	const G4double	y[],
		G4double	Field[]
	)

inline

Definition at line 106 of file G4ConstRK4.hh.

{
  G4double PositionAndTime[4];
 
  PositionAndTime[0] = y[0];
  PositionAndTime[1] = y[1];
  PositionAndTime[2] = y[2];
  // Global Time
  PositionAndTime[3] = y[7];
  fEq -> GetFieldValue(PositionAndTime, B);
}

References B(), and fEq.

Referenced by Stepper().

◆ GetEquationOfMotion() [1/2]

G4EquationOfMotion * G4MagIntegratorStepper::GetEquationOfMotion ( )

inlineinherited

Referenced by G4MagInt_Driver::GetEquationOfMotion(), G4OldMagIntDriver::GetEquationOfMotion(), G4NystromRK4::GetField(), G4DormandPrince745::GetSpecificEquation(), G4NystromRK4::SetDistanceForConstantField(), G4RKG3_Stepper::StepNoErr(), and G4RKG3_Stepper::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(), 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 G4ConstRK4::IntegratorOrder ( ) const

inlinevirtual

Implements G4MagIntegratorStepper.

Definition at line 74 of file G4ConstRK4.hh.

74{ return 4; }

Referenced by Stepper().

◆ 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

◆ operator=()

G4ConstRK4 & G4ConstRK4::operator= ( const G4ConstRK4 & )

delete

◆ 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

◆ RightHandSideConst()

void G4ConstRK4::RightHandSideConst	(	const G4double	y[],
		G4double	dydx[]
	)		const

inline

Definition at line 88 of file G4ConstRK4.hh.

{
  
  G4double momentum_mag_square = y[3]*y[3] + y[4]*y[4] + y[5]*y[5];
  G4double inv_momentum_magnitude = 1.0 / std::sqrt( momentum_mag_square );
    
  G4double cof = fEq->FCof()*inv_momentum_magnitude;
 
  dydx[0] = y[3]*inv_momentum_magnitude;       //  (d/ds)x = Vx/V
  dydx[1] = y[4]*inv_momentum_magnitude;       //  (d/ds)y = Vy/V
  dydx[2] = y[5]*inv_momentum_magnitude;       //  (d/ds)z = Vz/V
 
  dydx[3] = cof*(y[4]*Field[2] - y[5]*Field[1]) ;   // Ax = a*(Vy*Bz - Vz*By)
  dydx[4] = cof*(y[5]*Field[0] - y[3]*Field[2]) ;   // Ay = a*(Vz*Bx - Vx*Bz)
  dydx[5] = cof*(y[3]*Field[1] - y[4]*Field[0]) ;   // Az = a*(Vx*By - Vy*Bx)
}

References G4Mag_EqRhs::FCof(), fEq, and Field.

Referenced by DumbStepper(), and Stepper().

◆ 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().

◆ Stepper()

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

virtual

Implements G4MagIntegratorStepper.

Definition at line 146 of file G4ConstRK4.cc.

{
   const G4int nvar = 6;  // number of variables integrated
   const G4int maxvar = GetNumberOfStateVariables();
 
   // Correction for Richardson extrapolation
   G4double  correction = 1. / ( (1 << IntegratorOrder()) -1 );
 
   G4int i;
   
   // Saving yInput because yInput and yOutput can be aliases for same array
   for (i=0;    i<maxvar; ++i) { yInitial[i]= yInput[i]; }
 
   // Must copy the part of the state *not* integrated to the output
   for (i=nvar; i<maxvar; ++i) { yOutput[i]=  yInput[i]; }
 
   // yInitial[7]= yInput[7];  //  The time is typically needed
   yMiddle[7]  = yInput[7];   // Copy the time from initial value 
   yOneStep[7] = yInput[7];   // As it contributes to final value of yOutput ?
   // yOutput[7] = yInput[7];  // -> dumb stepper does it too for RK4
   yError[7] = 0.0;         
 
   G4double halfStep = hstep * 0.5; 
 
   // Do two half steps
   //
   GetConstField(yInitial,Field);
   DumbStepper  (yInitial,  dydx,   halfStep, yMiddle);
   RightHandSideConst(yMiddle, dydxMid);    
   DumbStepper  (yMiddle, dydxMid, halfStep, yOutput); 
 
   // Store midpoint, chord calculation
   //
   fMidPoint = G4ThreeVector( yMiddle[0],  yMiddle[1],  yMiddle[2]); 
 
   // Do a full Step
   //
   DumbStepper(yInitial, dydx, hstep, yOneStep);
   for(i=0; i<nvar; ++i)
   {
      yError [i] = yOutput[i] - yOneStep[i] ;
      yOutput[i] += yError[i]*correction ;
        // Provides accuracy increased by 1 order via the 
        // Richardson extrapolation  
   }
 
   fInitialPoint = G4ThreeVector( yInitial[0], yInitial[1], yInitial[2]); 
   fFinalPoint   = G4ThreeVector( yOutput[0],  yOutput[1],  yOutput[2]); 
 
   return;
}

References DumbStepper(), dydxMid, fFinalPoint, Field, fInitialPoint, fMidPoint, GetConstField(), G4MagIntegratorStepper::GetNumberOfStateVariables(), IntegratorOrder(), RightHandSideConst(), yInitial, yMiddle, and yOneStep.

Field Documentation

◆ dydxm

G4double* G4ConstRK4::dydxm

private

Definition at line 80 of file G4ConstRK4.hh.

Referenced by DumbStepper(), G4ConstRK4(), and ~G4ConstRK4().

◆ dydxMid

G4double * G4ConstRK4::dydxMid

private

Definition at line 81 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), Stepper(), and ~G4ConstRK4().

◆ dydxt

G4double * G4ConstRK4::dydxt

private

Definition at line 80 of file G4ConstRK4.hh.

Referenced by DumbStepper(), G4ConstRK4(), and ~G4ConstRK4().

◆ fEq

G4Mag_EqRhs* G4ConstRK4::fEq = nullptr

private

Definition at line 82 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), GetConstField(), and RightHandSideConst().

◆ fEquation_Rhs

G4EquationOfMotion* G4MagIntegratorStepper::fEquation_Rhs = nullptr

privateinherited

Definition at line 124 of file G4MagIntegratorStepper.hh.

◆ fFinalPoint

G4ThreeVector G4ConstRK4::fFinalPoint

private

Definition at line 78 of file G4ConstRK4.hh.

Referenced by DistChord(), and Stepper().

◆ Field

G4double G4ConstRK4::Field[3]

private

Definition at line 83 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), RightHandSideConst(), and Stepper().

◆ fInitialPoint

G4ThreeVector G4ConstRK4::fInitialPoint

private

Definition at line 78 of file G4ConstRK4.hh.

Referenced by DistChord(), and Stepper().

◆ 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.

◆ fMidPoint

G4ThreeVector G4ConstRK4::fMidPoint

private

Definition at line 78 of file G4ConstRK4.hh.

Referenced by DistChord(), and Stepper().

◆ 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.

◆ yInitial

G4double* G4ConstRK4::yInitial

private

Definition at line 81 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), Stepper(), and ~G4ConstRK4().

◆ yMiddle

G4double * G4ConstRK4::yMiddle

private

Definition at line 81 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), Stepper(), and ~G4ConstRK4().

◆ yOneStep

G4double * G4ConstRK4::yOneStep

private

Definition at line 81 of file G4ConstRK4.hh.

Referenced by G4ConstRK4(), Stepper(), and ~G4ConstRK4().

◆ yt

G4double * G4ConstRK4::yt

private

Definition at line 80 of file G4ConstRK4.hh.

Referenced by DumbStepper(), G4ConstRK4(), and ~G4ConstRK4().

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4ConstRK4() [1/2]

◆ ~G4ConstRK4()

◆ G4ConstRK4() [2/2]

Member Function Documentation

◆ DistChord()

◆ DumbStepper()

◆ GetConstField()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ operator=()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ RightHandSideConst()

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ Stepper()

Field Documentation

◆ dydxm

◆ dydxMid

◆ dydxt

◆ fEq

◆ fEquation_Rhs

◆ fFinalPoint

◆ Field

◆ fInitialPoint

◆ fIntegrationOrder

◆ fIsFSAL

◆ fMidPoint

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ yInitial

◆ yMiddle

◆ yOneStep

◆ yt