#include <G4TCashKarpRKF45.hh>

Inheritance diagram for G4TCashKarpRKF45< T_Equation, N >:

Public Member Functions
G4double	DistChord () const override

	G4TCashKarpRKF45 (T_Equation *EqRhs, G4bool primary=true)

G4EquationOfMotion *	GetEquationOfMotion ()

const G4EquationOfMotion *	GetEquationOfMotion () const

unsigned long	GetfNoRHSCalls ()

G4int	GetNumberOfStateVariables () const

G4int	GetNumberOfVariables () const

G4int	IntegrationOrder ()

G4int	IntegratorOrder () const override

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	RightHandSideInl (const G4double y[], G4double dydx[])

void	SetEquationOfMotion (G4EquationOfMotion *newEquation)

virtual void	Stepper (const G4double yInput[], const G4double dydx[], G4double hstep, G4double yOutput[], G4double yError[]) override final

void	StepWithError (const G4double yInput[], const G4double dydx[], G4double Step, G4double yOut[], G4double yErr[])

virtual	~G4TCashKarpRKF45 ()

Protected Member Functions
void	SetFSAL (G4bool flag=true)

void	SetIntegrationOrder (G4int order)

Private Member Functions
	G4TCashKarpRKF45 (const G4TCashKarpRKF45 &)

G4TCashKarpRKF45 &	operator= (const G4TCashKarpRKF45 &)

Private Attributes
G4double	ak2 [N]

G4double	ak3 [N]

G4double	ak4 [N]

G4double	ak5 [N]

G4double	ak6 [N]

G4double	ak7 [N]

G4TCashKarpRKF45 *	fAuxStepper = nullptr

T_Equation *	fEquation_Rhs

G4int	fIntegrationOrder = -1

G4bool	fIsFSAL = false

G4double *	fLastDyDx

G4double *	fLastFinalVector

G4double *	fLastInitialVector

G4double	fLastStepLength = 0.0

G4double *	fMidError

G4double *	fMidVector

const G4int	fNoIntegrationVariables = 0

unsigned long	fNoRHSCalls = 0UL

const G4int	fNoStateVariables = 0

G4double	yIn [N]

G4double	yTemp [N]

Detailed Description

template<class T_Equation, unsigned int N = 6>
class G4TCashKarpRKF45< T_Equation, N >

Definition at line 63 of file G4TCashKarpRKF45.hh.

Constructor & Destructor Documentation

◆ G4TCashKarpRKF45() [1/2]

template<class T_Equation , unsigned int N>

G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45	(	T_Equation *	EqRhs,
		G4bool	primary = `true`
	)

Definition at line 123 of file G4TCashKarpRKF45.hh.

    : G4MagIntegratorStepper(dynamic_cast<G4EquationOfMotion*>(EqRhs), N )
    , fEquation_Rhs(EqRhs)
{
  if( dynamic_cast<G4EquationOfMotion*>(EqRhs) == nullptr )
  {
    G4Exception("G4TCashKarpRKF45: constructor", "GeomField0001",
                FatalException, "Equation is not an G4EquationOfMotion.");      
  }
    
  fLastInitialVector = new G4double[N];
  fLastFinalVector   = new G4double[N];
  fLastDyDx          = new G4double[N];
  
  fMidVector = new G4double[N];
  fMidError  = new G4double[N];
  
  if(primary)
  {
     fAuxStepper = new G4TCashKarpRKF45<T_Equation, N> (EqRhs, !primary);
  }
}

References FatalException, G4TCashKarpRKF45< T_Equation, N >::fAuxStepper, G4TCashKarpRKF45< T_Equation, N >::fLastDyDx, G4TCashKarpRKF45< T_Equation, N >::fLastFinalVector, G4TCashKarpRKF45< T_Equation, N >::fLastInitialVector, G4TCashKarpRKF45< T_Equation, N >::fMidError, G4TCashKarpRKF45< T_Equation, N >::fMidVector, and G4Exception().

◆ ~G4TCashKarpRKF45()

template<class T_Equation , unsigned int N>

G4TCashKarpRKF45< T_Equation, N >::~G4TCashKarpRKF45

virtual

Definition at line 148 of file G4TCashKarpRKF45.hh.

{
  delete[] fLastInitialVector;
  delete[] fLastFinalVector;
  delete[] fLastDyDx;
  delete[] fMidVector;
  delete[] fMidError;
  
  delete fAuxStepper;
}

◆ G4TCashKarpRKF45() [2/2]

template<class T_Equation , unsigned int N = 6>

G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45 ( const G4TCashKarpRKF45< T_Equation, N > & )

private

Member Function Documentation

◆ DistChord()

template<class T_Equation , unsigned int N>

G4double G4TCashKarpRKF45< T_Equation, N >::DistChord

inlineoverridevirtual

Implements G4MagIntegratorStepper.

Definition at line 270 of file G4TCashKarpRKF45.hh.

{
  G4double distLine, distChord;
  G4ThreeVector initialPoint, finalPoint, midPoint;
  
  // Store last initial and final points (they will be overwritten in
  // self-Stepper call!)
  initialPoint = G4ThreeVector(fLastInitialVector[0], fLastInitialVector[1],
                               fLastInitialVector[2]);
  finalPoint   = G4ThreeVector(fLastFinalVector[0], fLastFinalVector[1],
                               fLastFinalVector[2]);
 
  // Do half a step using StepNoErr
  
  fAuxStepper->G4TCashKarpRKF45::Stepper(fLastInitialVector, fLastDyDx,
                                         0.5 * fLastStepLength, fMidVector,
                                         fMidError);
  
  midPoint = G4ThreeVector(fMidVector[0], fMidVector[1], fMidVector[2]);
  
  // Use stored values of Initial and Endpoint + new Midpoint to evaluate
  //  distance of Chord
  
  if(initialPoint != finalPoint)
  {
    distLine  = G4LineSection::Distline(midPoint, initialPoint, finalPoint);
    distChord = distLine;
  }
  else
  {
    distChord = (midPoint - initialPoint).mag();
  }
  return distChord;
}

References G4LineSection::Distline().

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

template<class T_Equation , unsigned int N = 6>

G4int G4TCashKarpRKF45< T_Equation, N >::IntegratorOrder ( ) const

inlineoverridevirtual

Implements G4MagIntegratorStepper.

Definition at line 94 of file G4TCashKarpRKF45.hh.

94{ 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

◆ operator=()

template<class T_Equation , unsigned int N = 6>

G4TCashKarpRKF45 & G4TCashKarpRKF45< T_Equation, N >::operator= ( const G4TCashKarpRKF45< T_Equation, N > & )

private

◆ 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

◆ RightHandSideInl()

template<class T_Equation , unsigned int N = 6>

void G4TCashKarpRKF45< T_Equation, N >::RightHandSideInl	(	const G4double	y[],
		G4double	dydx[]
	)

inline

Definition at line 86 of file G4TCashKarpRKF45.hh.

  {
    fEquation_Rhs->T_Equation::RightHandSide(y, dydx);
  }

References G4TCashKarpRKF45< T_Equation, N >::fEquation_Rhs.

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

template<class T_Equation , unsigned int N>

void G4TCashKarpRKF45< T_Equation, N >::Stepper	(	const G4double	yInput[],
		const G4double	dydx[],
		G4double	hstep,
		G4double	yOutput[],
		G4double	yError[]
	)

inlinefinaloverridevirtual

Implements G4MagIntegratorStepper.

Definition at line 307 of file G4TCashKarpRKF45.hh.

{
  assert( yOutput != yInput );
  assert( yError  != yInput );
  
  StepWithError( yInput, dydx, Step, yOutput, yError);
}

◆ StepWithError()

template<class T_Equation , unsigned int N = 6>

void G4TCashKarpRKF45< T_Equation, N >::StepWithError	(	const G4double	yInput[],
		const G4double	dydx[],
		G4double	Step,
		G4double	yOut[],
		G4double	yErr[]
	)

inline

Definition at line 171 of file G4TCashKarpRKF45.hh.

{
  // const G4double a2 = 0.2 , a3 = 0.3 , a4 = 0.6 , a5 = 1.0 , a6 = 0.875;
 
  const G4double b21 = 0.2, b31 = 3.0 / 40.0, b32 = 9.0 / 40.0, b41 = 0.3,
                 b42 = -0.9, b43 = 1.2,
     
                 b51 = -11.0 / 54.0, b52 = 2.5, b53 = -70.0 / 27.0,
                 b54 = 35.0 / 27.0,
 
                 b61 = 1631.0 / 55296.0, b62 = 175.0 / 512.0,
                 b63 = 575.0 / 13824.0, b64 = 44275.0 / 110592.0,
                 b65 = 253.0 / 4096.0,
 
                 c1 = 37.0 / 378.0, c3 = 250.0 / 621.0, c4 = 125.0 / 594.0,
                 c6 = 512.0 / 1771.0, dc5 = -277.0 / 14336.0;
 
  const G4double dc1 = c1 - 2825.0 / 27648.0, dc3 = c3 - 18575.0 / 48384.0,
                 dc4 = c4 - 13525.0 / 55296.0, dc6 = c6 - 0.25;
 
  // Initialise time to t0, needed when it is not updated by the integration.
  //       [ Note: Only for time dependent fields (usually electric)
  //                 is it neccessary to integrate the time.]
  // yOut[7] = yTemp[7]   = yIn[7];
 
  //  Saving yInput because yInput and yOut can be aliases for same array
  for(unsigned int i = 0; i < N; ++i)
  {
    yIn[i] = yInput[i];
  }
  // RightHandSideInl(yIn, dydx) ;              // 1st Step
 
  for(unsigned int i = 0; i < N; ++i)
  {
    yTemp[i] = yIn[i] + b21 * Step * dydx[i];
  }
  this->RightHandSideInl(yTemp, ak2);  // 2nd Step
 
  for(unsigned int i = 0; i < N; ++i)
  {
    yTemp[i] = yIn[i] + Step * (b31 * dydx[i] + b32 * ak2[i]);
  }
  this->RightHandSideInl(yTemp, ak3);  // 3rd Step
  
  for(unsigned int i = 0; i < N; ++i)
  {
    yTemp[i] = yIn[i] + Step * (b41 * dydx[i] + b42 * ak2[i] + b43 * ak3[i]);
  }
  this->RightHandSideInl(yTemp, ak4);  // 4th Step
  
  for(unsigned int i = 0; i < N; ++i)
  {
    yTemp[i] = yIn[i] + Step * (b51 * dydx[i] + b52 * ak2[i] + b53 * ak3[i] +
                                b54 * ak4[i]);
  }
  this->RightHandSideInl(yTemp, ak5);  // 5th Step
  
  for(unsigned int i = 0; i < N; ++i)
  {
    yTemp[i] = yIn[i] + Step * (b61 * dydx[i] + b62 * ak2[i] + b63 * ak3[i] +
                                b64 * ak4[i] + b65 * ak5[i]);
  }
  this->RightHandSideInl(yTemp, ak6);  // 6th Step
 
  for(unsigned int i = 0; i < N; ++i)
  {
    // Accumulate increments with proper weights
     
    yOut[i] = yIn[i] +
       Step * (c1 * dydx[i] + c3 * ak3[i] + c4 * ak4[i] + c6 * ak6[i]);
  }
  for(unsigned int i = 0; i < N; ++i)
  {
    // Estimate error as difference between 4th and
    // 5th order methods
     
    yErr[i] = Step * (dc1 * dydx[i] + dc3 * ak3[i] + dc4 * ak4[i] +
                      dc5 * ak5[i] + dc6 * ak6[i]);
  }
  for(unsigned int i = 0; i < N; ++i)
  {
    // Store Input and Final values, for possible use in calculating chord
    fLastInitialVector[i] = yIn[i];
    fLastFinalVector[i]   = yOut[i];
    fLastDyDx[i]          = dydx[i];
  }
  // NormaliseTangentVector( yOut ); // Not wanted
  
  fLastStepLength = Step;
  
  return;
}

References ak2.

Field Documentation

◆ ak2

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak2[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ ak3

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak3[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ ak4

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak4[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ ak5

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak5[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ ak6

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak6[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ ak7

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::ak7[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ fAuxStepper

template<class T_Equation , unsigned int N = 6>

G4TCashKarpRKF45* G4TCashKarpRKF45< T_Equation, N >::fAuxStepper = nullptr

private

Definition at line 113 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

◆ fEquation_Rhs

template<class T_Equation , unsigned int N = 6>

T_Equation* G4TCashKarpRKF45< T_Equation, N >::fEquation_Rhs

private

Definition at line 115 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::RightHandSideInl().

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

◆ fLastDyDx

template<class T_Equation , unsigned int N = 6>

G4double* G4TCashKarpRKF45< T_Equation, N >::fLastDyDx

private

Definition at line 108 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

◆ fLastFinalVector

template<class T_Equation , unsigned int N = 6>

G4double* G4TCashKarpRKF45< T_Equation, N >::fLastFinalVector

private

Definition at line 107 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

◆ fLastInitialVector

template<class T_Equation , unsigned int N = 6>

G4double* G4TCashKarpRKF45< T_Equation, N >::fLastInitialVector

private

Definition at line 106 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

◆ fLastStepLength

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::fLastStepLength = 0.0

private

Definition at line 105 of file G4TCashKarpRKF45.hh.

◆ fMidError

template<class T_Equation , unsigned int N = 6>

G4double* G4TCashKarpRKF45< T_Equation, N >::fMidError

private

Definition at line 110 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

◆ fMidVector

template<class T_Equation , unsigned int N = 6>

G4double* G4TCashKarpRKF45< T_Equation, N >::fMidVector

private

Definition at line 109 of file G4TCashKarpRKF45.hh.

Referenced by G4TCashKarpRKF45< T_Equation, N >::G4TCashKarpRKF45().

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

◆ yIn

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::yIn[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

◆ yTemp

template<class T_Equation , unsigned int N = 6>

G4double G4TCashKarpRKF45< T_Equation, N >::yTemp[N]

private

Definition at line 102 of file G4TCashKarpRKF45.hh.

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

source/geometry/magneticfield/include/G4TCashKarpRKF45.hh

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4TCashKarpRKF45() [1/2]

◆ ~G4TCashKarpRKF45()

◆ G4TCashKarpRKF45() [2/2]

Member Function Documentation

◆ DistChord()

◆ GetEquationOfMotion() [1/2]

◆ GetEquationOfMotion() [2/2]

◆ GetfNoRHSCalls()

◆ GetNumberOfStateVariables()

◆ GetNumberOfVariables()

◆ IntegrationOrder()

◆ IntegratorOrder()

◆ IsFSAL()

◆ NormalisePolarizationVector()

◆ NormaliseTangentVector()

◆ operator=()

◆ ResetfNORHSCalls()

◆ RightHandSide() [1/2]

◆ RightHandSide() [2/2]

◆ RightHandSideInl()

◆ SetEquationOfMotion()

◆ SetFSAL()

◆ SetIntegrationOrder()

◆ Stepper()

◆ StepWithError()

Field Documentation

◆ ak2

◆ ak3

◆ ak4

◆ ak5

◆ ak6

◆ ak7

◆ fAuxStepper

◆ fEquation_Rhs

◆ fIntegrationOrder

◆ fIsFSAL

◆ fLastDyDx

◆ fLastFinalVector

◆ fLastInitialVector

◆ fLastStepLength

◆ fMidError

◆ fMidVector

◆ fNoIntegrationVariables

◆ fNoRHSCalls

◆ fNoStateVariables

◆ yIn

◆ yTemp