#include <G4MagErrorStepper.hh>

Inheritance diagram for G4MagErrorStepper:

Public Member Functions
G4double	DistChord () const

virtual void	DumbStepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[])=0

	G4MagErrorStepper (const G4MagErrorStepper &)=delete

	G4MagErrorStepper (G4EquationOfMotion *EqRhs, G4int numberOfVariables, G4int numStateVariables=12)

G4EquationOfMotion *	GetEquationOfMotion ()

const G4EquationOfMotion *	GetEquationOfMotion () const

unsigned long	GetfNoRHSCalls ()

G4int	GetNumberOfStateVariables () const

G4int	GetNumberOfVariables () const

G4int	IntegrationOrder ()

virtual G4int	IntegratorOrder () const =0

G4bool	IsFSAL () const

void	NormalisePolarizationVector (G4double vec[12])

void	NormaliseTangentVector (G4double vec[6])

G4MagErrorStepper &	operator= (const G4MagErrorStepper &)=delete

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	Stepper (const G4double y[], const G4double dydx[], G4double h, G4double yout[], G4double yerr[])

virtual	~G4MagErrorStepper ()

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Attributes
G4double *	dydxMid

G4EquationOfMotion *	fEquation_Rhs = nullptr

G4ThreeVector	fFinalPoint

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

Detailed Description

Definition at line 43 of file G4MagErrorStepper.hh.

Constructor & Destructor Documentation

◆ G4MagErrorStepper() [1/2]

G4MagErrorStepper::G4MagErrorStepper	(	G4EquationOfMotion *	EqRhs,
		G4int	numberOfVariables,
		G4int	numStateVariables = `12`
	)

◆ ~G4MagErrorStepper()

G4MagErrorStepper::~G4MagErrorStepper ( )

virtual

Definition at line 34 of file G4MagErrorStepper.cc.

{
   delete [] yMiddle;
   delete [] dydxMid;
   delete [] yInitial;
   delete [] yOneStep;
}

References dydxMid, yInitial, yMiddle, and yOneStep.

◆ G4MagErrorStepper() [2/2]

G4MagErrorStepper::G4MagErrorStepper ( const G4MagErrorStepper & )

delete

Member Function Documentation

◆ DistChord()

G4double G4MagErrorStepper::DistChord ( ) const

virtual

Implements G4MagIntegratorStepper.

Definition at line 100 of file G4MagErrorStepper.cc.

{
  // Estimate the maximum distance from the curve to the chord
  //
  // We estimate this using the distance of the midpoint to 
  // chord (the line between 
  // 
  // Method below is good only for angle deviations < 2 pi, 
  // This restriction should not a problem for the Runge cutta methods, 
  // which generally cannot integrate accurately for large angle deviations.
 
  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()

virtual void G4MagErrorStepper::DumbStepper	(	const G4double	y[],
		const G4double	dydx[],
		G4double	h,
		G4double	yout[]
	)

pure virtual

Implemented in G4ExplicitEuler, G4ImplicitEuler, G4SimpleHeum, G4SimpleRunge, G4ClassicalRK4, and G4ConstRK4.

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(), G4ConstRK4::Stepper(), 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(), Stepper(), G4TsitourasRK45::Stepper(), and G4DormandPrince745::Stepper().

◆ IntegrationOrder()

G4int G4MagIntegratorStepper::IntegrationOrder ( )

inlineinherited

◆ IntegratorOrder()

virtual G4int G4MagIntegratorStepper::IntegratorOrder ( ) const

pure virtualinherited

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

G4MagErrorStepper & G4MagErrorStepper::operator= ( const G4MagErrorStepper & )

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

◆ 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 G4MagErrorStepper::Stepper	(	const G4double	y[],
		const G4double	dydx[],
		G4double	h,
		G4double	yout[],
		G4double	yerr[]
	)

virtual

Implements G4MagIntegratorStepper.

Definition at line 42 of file G4MagErrorStepper.cc.

{  
   const G4int nvar = GetNumberOfVariables();
   const G4int maxvar = GetNumberOfStateVariables();
 
   // correction for Richardson Extrapolation.
   //
   G4double  correction = 1. / ( (1 << IntegratorOrder()) -1 );
   
   //  Saving yInput because yInput and yOutput can be aliases for same array
   //
   for(G4int i=0; i<nvar; ++i)
   {
     yInitial[i]=yInput[i];
   }
   yInitial[7] = yInput[7]; // Copy the time in case...even if not really 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
 
   for(G4int i=nvar; i<maxvar; ++i)
   {
     yOutput[i]=yInput[i];
   }
   // yError[7] = 0.0;         
 
   G4double halfStep = hstep * 0.5; 
 
   // Do two half steps
   //
   DumbStepper  (yInitial,  dydx,   halfStep, yMiddle);
   RightHandSide(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(G4int i=0; i<nvar; ++i)
   {
      yError [i] = yOutput[i] - yOneStep[i] ;
      yOutput[i] += yError[i]*correction ;
        // Provides accuracy increased by 1 order via Richardson Extrapolation  
   }
 
   fInitialPoint = G4ThreeVector( yInitial[0], yInitial[1], yInitial[2]); 
   fFinalPoint   = G4ThreeVector( yOutput[0],  yOutput[1],  yOutput[2]); 
 
   return;
}

References DumbStepper(), dydxMid, fFinalPoint, fInitialPoint, fMidPoint, G4MagIntegratorStepper::GetNumberOfStateVariables(), G4MagIntegratorStepper::GetNumberOfVariables(), G4MagIntegratorStepper::IntegratorOrder(), G4MagIntegratorStepper::RightHandSide(), yInitial, yMiddle, and yOneStep.

Field Documentation

◆ dydxMid

G4double * G4MagErrorStepper::dydxMid

private

Definition at line 80 of file G4MagErrorStepper.hh.

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

◆ fEquation_Rhs

G4EquationOfMotion* G4MagIntegratorStepper::fEquation_Rhs = nullptr

privateinherited

Definition at line 124 of file G4MagIntegratorStepper.hh.

◆ fFinalPoint

G4ThreeVector G4MagErrorStepper::fFinalPoint

private

Definition at line 76 of file G4MagErrorStepper.hh.

Referenced by DistChord(), and Stepper().

◆ fInitialPoint

G4ThreeVector G4MagErrorStepper::fInitialPoint

private

Definition at line 76 of file G4MagErrorStepper.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 G4MagErrorStepper::fMidPoint

private

Definition at line 76 of file G4MagErrorStepper.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* G4MagErrorStepper::yInitial

private

Definition at line 80 of file G4MagErrorStepper.hh.

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

◆ yMiddle

G4double * G4MagErrorStepper::yMiddle

private

Definition at line 80 of file G4MagErrorStepper.hh.

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

◆ yOneStep

G4double * G4MagErrorStepper::yOneStep

private

Definition at line 80 of file G4MagErrorStepper.hh.

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

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4MagErrorStepper() [1/2]

◆ ~G4MagErrorStepper()

◆ G4MagErrorStepper() [2/2]

Member Function Documentation

◆ DistChord()

◆ DumbStepper()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ operator=()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ Stepper()

Field Documentation

◆ dydxMid

◆ fEquation_Rhs

◆ fFinalPoint

◆ fInitialPoint

◆ fIntegrationOrder

◆ fIsFSAL

◆ fMidPoint

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ yInitial

◆ yMiddle

◆ yOneStep